aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authormerakor <cem@ckyln.com>2021-07-27 09:24:26 +0000
committermerakor <cem@ckyln.com>2021-07-27 09:24:26 +0000
commitab960e47945033bea128474a255ccf52ea1ddf6c (patch)
tree4ce7f857fcba417dbe709bf7a6ec1b61e8053f60 /docs
parentd8bb119df5965b154719958656032e38abc52ec3 (diff)
parent57093831d9c125b1ee872ecf21792324d2238354 (diff)
downloadcpt-ab960e47945033bea128474a255ccf52ea1ddf6c.tar.gz
blake3: merge trunk
FossilOrigin-Name: 8bba905c9082ee971fbe79d4be7eaa96072362689725add1f5341c0ec1d282fa
Diffstat (limited to 'docs')
-rw-r--r--docs/cpt.org42
-rw-r--r--docs/cpt.texi41
-rw-r--r--docs/cpt.txt41
3 files changed, 100 insertions, 24 deletions
diff --git a/docs/cpt.org b/docs/cpt.org
index d78254c..7496ec9 100644
--- a/docs/cpt.org
+++ b/docs/cpt.org
@@ -161,65 +161,84 @@ to provide detailed information.
#+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_VERBOSE~ ::
+
+ #+VINDEX: CPT_VERBOSE
+ If this variable is set to 1, the package manager will print more information.
+
*** =CPT_PATH=
:PROPERTIES:
:DESCRIPTION: Set the locations of your repositories
@@ -534,6 +553,9 @@ license: MIT
maintainer: Linux User <linux-user@example.com>
#+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
@@ -705,10 +727,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
@@ -1195,14 +1218,17 @@ rsync curl zlib ca-certificates bearssl
This function is used to query the [[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 =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 =meta= file or the file does not contain the
+requested key, the function will return with 1.
#+begin_src sh
$ pkg_query_meta cpt description
Carbs Packaging Tools
+
+$ pkg_query_meta /path/to/cpt license
+MIT
#+end_src
* {{{index(Concept, cp)}}}
diff --git a/docs/cpt.texi b/docs/cpt.texi
index 525029c..8bdcd99 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
@@ -671,6 +689,9 @@ license: MIT
maintainer: Linux User <linux-user@@example.com>
@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
@@ -836,10 +857,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
@@ -1358,14 +1380,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 144ff8b..550a6a3 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'
----------------
@@ -585,6 +603,9 @@ development manual for *Carbs Packaging Tools*. For development logs see
| maintainer: Linux User <linux-user@example.com>
`----
+ 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
@@ -758,11 +779,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
@@ -1264,13 +1285,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
`----