From 4d3a7455b536b7bf934561eb5ec187b1653aabb4 Mon Sep 17 00:00:00 2001 From: merakor Date: Sat, 17 Jul 2021 22:51:10 +0000 Subject: docs: update FossilOrigin-Name: cb5549b4ba93ef506dbfeda10b817536982d92e809762247f81e00e6bc07924c --- docs/cpt.texi | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) (limited to 'docs/cpt.texi') 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 -- cgit v1.2.3 From a61e707828228c11860c6573ca992ad55a379c0a Mon Sep 17 00:00:00 2001 From: merakor Date: Mon, 19 Jul 2021 12:25:07 +0000 Subject: docs: update FossilOrigin-Name: 5a09d7034d312982d515f96307837351ec067084fafd7973e29384dc8b44baf1 --- docs/cpt.texi | 11 +++++++---- docs/cpt.txt | 10 +++++++--- 2 files changed, 14 insertions(+), 7 deletions(-) (limited to 'docs/cpt.texi') diff --git a/docs/cpt.texi b/docs/cpt.texi index 8b7bb77..b16fea7 100644 --- a/docs/cpt.texi +++ b/docs/cpt.texi @@ -1377,14 +1377,17 @@ rsync curl zlib ca-certificates bearssl This function is used to query the @ref{meta, , meta file} inside package directories. It can be used to retrieve information on a package that is otherwise irrelevant to the -package manager itself. It takes two arguments, first being the package and the -second being the key to be retrieved. If the package does not have a @samp{meta} -file or the file does not contain the requested key, the function will return -with 1. +package manager itself. It takes two arguments, first being the package (or the +full path to a package directory) and the second being the key to be retrieved. +If the package does not have a @samp{meta} file or the file does not contain the +requested key, the function will return with 1. @example $ pkg_query_meta cpt description Carbs Packaging Tools + +$ pkg_query_meta /path/to/cpt license +MIT @end example @node Concept Index diff --git a/docs/cpt.txt b/docs/cpt.txt index 78b0e6e..4e680b5 100644 --- a/docs/cpt.txt +++ b/docs/cpt.txt @@ -1282,13 +1282,17 @@ development manual for *Carbs Packaging Tools*. For development logs see This function is used to query the [meta file] inside package directories. It can be used to retrieve information on a package that is otherwise irrelevant to the package manager itself. It takes two - arguments, first being the package and the second being the key to be - retrieved. If the package does not have a `meta' file or the file does - not contain the requested key, the function will return with 1. + arguments, first being the package (or the full path to a package + directory) and the second being the key to be retrieved. If the + package does not have a `meta' file or the file does not contain the + requested key, the function will return with 1. ,---- | $ pkg_query_meta cpt description | Carbs Packaging Tools + | + | $ pkg_query_meta /path/to/cpt license + | MIT `---- -- cgit v1.2.3 From e88492c6a19868600fc60003c17203aebde74cf8 Mon Sep 17 00:00:00 2001 From: merakor Date: Thu, 22 Jul 2021 09:32:00 +0000 Subject: docs: update FossilOrigin-Name: 1f3b58f235d6ebae4244c5b76d4d80772939548154f947ec76a3b7fbb5567e8d --- docs/cpt.org | 3 +++ docs/cpt.texi | 3 +++ docs/cpt.txt | 3 +++ 3 files changed, 9 insertions(+) (limited to 'docs/cpt.texi') diff --git a/docs/cpt.org b/docs/cpt.org index 1e551fe..7496ec9 100644 --- a/docs/cpt.org +++ b/docs/cpt.org @@ -553,6 +553,9 @@ license: MIT maintainer: Linux User #+end_example +Even though =meta= is not mandatory by the packaging system, it is a mandatory +file for submitting packages to Carbs Linux repositories. + ** post-install :PROPERTIES: :DESCRIPTION: The post-installation script diff --git a/docs/cpt.texi b/docs/cpt.texi index b16fea7..8bdcd99 100644 --- a/docs/cpt.texi +++ b/docs/cpt.texi @@ -689,6 +689,9 @@ license: MIT maintainer: Linux User @end example +Even though @samp{meta} is not mandatory by the packaging system, it is a mandatory +file for submitting packages to Carbs Linux repositories. + @node post-install @section post-install diff --git a/docs/cpt.txt b/docs/cpt.txt index 4e680b5..550a6a3 100644 --- a/docs/cpt.txt +++ b/docs/cpt.txt @@ -603,6 +603,9 @@ development manual for *Carbs Packaging Tools*. For development logs see | maintainer: Linux User `---- + Even though `meta' is not mandatory by the packaging system, it is a + mandatory file for submitting packages to Carbs Linux repositories. + [pkg_query_meta()] See section 8.7.10 -- cgit v1.2.3