From a5295b5a8e87c436a8bf1a348a61378efe42ffdf Mon Sep 17 00:00:00 2001
From: merakor <cem@ckyln.com>
Date: Mon, 26 Apr 2021 11:19:54 +0000
Subject: docs: update

FossilOrigin-Name: 3fd04f97185161015b6cab4839f069440481aa9e358be466413e9126f9f8934e
---
 docs/cpt.org | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

(limited to 'docs/cpt.org')

diff --git a/docs/cpt.org b/docs/cpt.org
index 0a442d3..59087c0 100644
--- a/docs/cpt.org
+++ b/docs/cpt.org
@@ -8,6 +8,8 @@
 #+TEXINFO_DIR_DESC: Carbs Package Management Library
 #+OPTIONS: html-scripts:nil todo:nil
 
+#+MACRO: index (eval (format (if (org-export-derived-backend-p org-export-current-backend 'texinfo) "%s Index\n:PROPERTIES:\n:INDEX: %s\n:DESCRIPTION: %ss mentioned in this manual\n:END:\n" "%s%s%s :noexport:\n") $1 $2 $1))
+
 This is a reference document containing both the user-guide and the development
 manual for *Carbs Packaging Tools*. For development logs see [[https://git.carbslinux.org/cpt][the git repository]].
 
@@ -156,36 +158,66 @@ variables that alter the behaviour of =cpt=, some of them have separate sections
 to provide detailed information.
 
 - ~CPT_PATH~ ::
+
+  #+VINDEX: CPT_PATH
   Set the locations of your repositories. It is similar to the ~PATH~ variable.
 - ~CPT_CACHE~  ::
+
+  #+VINDEX: CPT_CACHE
   The cache directory for =cpt=. Default: ~$XDG_CACHE_HOME/cpt~.
 - ~CPT_CHOICE~ ::
+
+  #+VINDEX: CPT_CHOICE
   If this is set to 0, a package installation will be aborted on conflicts.
 - ~CPT_COLOR~ ::
+
+  #+VINDEX: CPT_COLOR
   If this is set to 1, =cpt= tools will be forced to display coloured output. If
   set to 0, they will be forced to display them without colours. Otherwise,
   =cpt= will output colour as long as it is outputting to a terminal.
 - ~CPT_DEBUG~ ::
+
+  #+VINDEX: CPT_DEBUG
   If set to 1, temporary directories will not be removed after the operation.
 - ~CPT_FETCH~ ::
+
+  #+VINDEX: CPT_FETCH
   If set to 0, ~cpt-update~ will not fetch repositories.
 - ~CPT_FORCE~ ::
+
+  #+VINDEX: CPT_FORCE
   If set to 1, =cpt= tools will force operation.
 - ~CPT_HOOK~ ::
+
+  #+VINDEX: CPT_HOOK
   Absolute path to the package manager hook file.
 - ~CPT_KEEPLOG~ ::
+
+  #+VINDEX: CPT_KEEPLOG
   If set to 1, =cpt= will keep logs regardless of operation success.
 - ~CPT_PID~ ::
+
+  #+VINDEX: CPT_PID
   Set the temporary build directory name.
 - ~CPT_PROMPT~ ::
+
+  #+VINDEX: CPT_PROMPT
   If set to 0, =cpt= will not prompt you for anything.
 - ~CPT_REPO_CACHE~ ::
+
+  #+VINDEX: CPT_REPO_CACHE
   If set to 0, =cpt= will not use or write repository information cache.
 - ~CPT_ROOT~ ::
+
+  #+VINDEX: CPT_ROOT
   If this variable is set, =cpt= will assume the given path as the system root.
 - ~CPT_TEST~ ::
+
+  #+VINDEX: CPT_TEST
   If set to 1, ~cpt-build~ will run tests whenever available.
 - ~CPT_TMPDIR~ ::
+
+  #+VINDEX: CPT_TMPDIR
   The directory to create the temporary directories.
 
 *** =CPT_PATH=
@@ -193,6 +225,7 @@ to provide detailed information.
 :DESCRIPTION: Set the locations of your repositories
 :END:
 
+#+CINDEX: Setting up repositories
 Similar to the =PATH= variable, =cpt= find repositories from the =CPT_PATH=
 variable. Here is an example:
 
@@ -215,6 +248,7 @@ This example brings us to the next section of this document.
 :DESCRIPTION: Prioritise package repositories
 :END:
 
+#+CINDEX: package conflicts
 When you are using multiple repositories from multiple vendors, you will find
 out that some repositories have the same packages. =cpt= doesn't care about
 conflicting packages. If you want to build a package that exists on multiple
@@ -522,6 +556,7 @@ installed.
 :DESCRIPTION: The test script for a package
 :END:
 
+#+VINDEX: CPT_TEST
 Test files are mainly for the repository maintainer to test the packages, and
 will only run if the user has the =CPT_TEST= variable set, or the build is
 run with the =-t= or =--test= options. This script is run on the
@@ -1121,3 +1156,6 @@ with 1.
 $ pkg_query_meta cpt description
 Carbs Packaging Tools
 #+end_src
+
+* {{{index(Concept, cp)}}}
+* {{{index(Variable,vr)}}}
-- 
cgit v1.2.3