aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authormerakor <cem@ckyln.com>2021-07-17 22:51:10 +0000
committermerakor <cem@ckyln.com>2021-07-17 22:51:10 +0000
commit4d3a7455b536b7bf934561eb5ec187b1653aabb4 (patch)
tree3868c9fe4ed252e8f2028906556da471c643c295 /docs
parenteb9d73e219325ae09b756144d56686118011fb64 (diff)
downloadcpt-4d3a7455b536b7bf934561eb5ec187b1653aabb4.tar.gz
docs: update
FossilOrigin-Name: cb5549b4ba93ef506dbfeda10b817536982d92e809762247f81e00e6bc07924c
Diffstat (limited to 'docs')
-rw-r--r--docs/cpt.org9
-rw-r--r--docs/cpt.texi27
-rw-r--r--docs/cpt.txt28
3 files changed, 51 insertions, 13 deletions
diff --git a/docs/cpt.org b/docs/cpt.org
index 3cc2198..aa7c2cc 100644
--- a/docs/cpt.org
+++ b/docs/cpt.org
@@ -724,10 +724,11 @@ be a huge issue for you.
:DESCRIPTION: Communicate with the users using your repository
:END:
-If a file named =motd= is found on the root directory of the package repository,
-its contents will be printed to the standard output when the users are updating
-their repositories. This method can be used to communicate messages to the
-users, such as package removals or otherwise important information.
+If a file named =MOTD= (all uppercase) is found on the root directory of the
+package repository, its contents will be printed to the standard output when the
+users are updating their repositories. This method can be used to communicate
+messages to the users, such as package removals or otherwise important
+information.
* Comparison Between CPT and KISS
diff --git a/docs/cpt.texi b/docs/cpt.texi
index 525029c..8b7bb77 100644
--- a/docs/cpt.texi
+++ b/docs/cpt.texi
@@ -280,50 +280,68 @@ to provide detailed information.
@item @code{CPT_PATH}
@vindex CPT_PATH
Set the locations of your repositories. It is similar to the @code{PATH} variable.
+
@item @code{CPT_CACHE}
@vindex CPT_CACHE
The cache directory for @samp{cpt}. Default: @code{$XDG_CACHE_HOME/cpt}.
+
@item @code{CPT_CHOICE}
@vindex CPT_CHOICE
If this is set to 0, a package installation will be aborted on conflicts.
+
@item @code{CPT_COLOR}
@vindex CPT_COLOR
If this is set to 1, @samp{cpt} tools will be forced to display coloured output. If
set to 0, they will be forced to display them without colours. Otherwise,
@samp{cpt} will output colour as long as it is outputting to a terminal.
+
@item @code{CPT_DEBUG}
@vindex CPT_DEBUG
If set to 1, temporary directories will not be removed after the operation.
+
@item @code{CPT_FETCH}
@vindex CPT_FETCH
If set to 0, @code{cpt-update} will not fetch repositories.
+
@item @code{CPT_FORCE}
@vindex CPT_FORCE
If set to 1, @samp{cpt} tools will force operation.
+
@item @code{CPT_HOOK}
@vindex CPT_HOOK
Absolute path to the package manager hook file.
+
@item @code{CPT_KEEPLOG}
@vindex CPT_KEEPLOG
If set to 1, @samp{cpt} will keep logs regardless of operation success.
+
@item @code{CPT_PID}
@vindex CPT_PID
Set the temporary build directory name.
+
@item @code{CPT_PROMPT}
@vindex CPT_PROMPT
If set to 0, @samp{cpt} will not prompt you for anything.
+
@item @code{CPT_REPO_CACHE}
@vindex CPT_REPO_CACHE
If set to 0, @samp{cpt} will not use or write repository information cache.
+
@item @code{CPT_ROOT}
@vindex CPT_ROOT
If this variable is set, @samp{cpt} will assume the given path as the system root.
+
@item @code{CPT_TEST}
@vindex CPT_TEST
If set to 1, @code{cpt-build} will run tests whenever available.
+
@item @code{CPT_TMPDIR}
@vindex CPT_TMPDIR
The directory to create the temporary directories.
+
+@item @code{CPT_VERBOSE}
+@vindex CPT_VERBOSE
+If this variable is set to 1, the package manager will print more information.
@end table
@menu
@@ -836,10 +854,11 @@ be a huge issue for you.
@node Message of the Day
@section Message of the Day
-If a file named @samp{motd} is found on the root directory of the package repository,
-its contents will be printed to the standard output when the users are updating
-their repositories. This method can be used to communicate messages to the
-users, such as package removals or otherwise important information.
+If a file named @samp{MOTD} (all uppercase) is found on the root directory of the
+package repository, its contents will be printed to the standard output when the
+users are updating their repositories. This method can be used to communicate
+messages to the users, such as package removals or otherwise important
+information.
@node Comparison Between CPT and KISS
@chapter Comparison Between CPT and KISS
diff --git a/docs/cpt.txt b/docs/cpt.txt
index 144ff8b..78b0e6e 100644
--- a/docs/cpt.txt
+++ b/docs/cpt.txt
@@ -226,43 +226,61 @@ development manual for *Carbs Packaging Tools*. For development logs see
`CPT_PATH'
Set the locations of your repositories. It is similar to the
`PATH' variable.
+
`CPT_CACHE'
The cache directory for `cpt'. Default: `$XDG_CACHE_HOME/cpt'.
+
`CPT_CHOICE'
If this is set to 0, a package installation will be aborted on
conflicts.
+
`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'
If set to 1, temporary directories will not be removed after the
operation.
+
`CPT_FETCH'
If set to 0, `cpt-update' will not fetch repositories.
+
`CPT_FORCE'
If set to 1, `cpt' tools will force operation.
+
`CPT_HOOK'
Absolute path to the package manager hook file.
+
`CPT_KEEPLOG'
If set to 1, `cpt' will keep logs regardless of operation
success.
+
`CPT_PID'
Set the temporary build directory name.
+
`CPT_PROMPT'
If set to 0, `cpt' will not prompt you for anything.
+
`CPT_REPO_CACHE'
If set to 0, `cpt' will not use or write repository information
cache.
+
`CPT_ROOT'
If this variable is set, `cpt' will assume the given path as the
system root.
+
`CPT_TEST'
If set to 1, `cpt-build' will run tests whenever available.
+
`CPT_TMPDIR'
The directory to create the temporary directories.
+ `CPT_VERBOSE'
+ If this variable is set to 1, the package manager will print
+ more information.
+
4.2.1 `CPT_PATH'
----------------
@@ -758,11 +776,11 @@ development manual for *Carbs Packaging Tools*. For development logs see
6.3 Message of the Day
~~~~~~~~~~~~~~~~~~~~~~
- If a file named `motd' is found on the root directory of the package
- repository, its contents will be printed to the standard output when
- the users are updating their repositories. This method can be used to
- communicate messages to the users, such as package removals or
- otherwise important information.
+ If a file named `MOTD' (all uppercase) is found on the root directory
+ of the package repository, its contents will be printed to the
+ standard output when the users are updating their repositories. This
+ method can be used to communicate messages to the users, such as
+ package removals or otherwise important information.
7 Comparison Between CPT and KISS