From 3080aeb2a0a5d80949a49fccaf505cd124f7c8d0 Mon Sep 17 00:00:00 2001 From: merakor Date: Fri, 24 Jul 2020 13:46:05 +0000 Subject: replace manual pages FossilOrigin-Name: 64396db2c76988929c50b63655bf3970acf3d2790e5828d6a36215cd5c1f2584 --- man/cpt-alternatives.1 | 44 ++++++++ man/cpt-build.1 | 15 +++ man/cpt-checksum.1 | 14 +++ man/cpt-contrib.1 | 126 +++++++++++++++++++++++ man/cpt-download.1 | 13 +++ man/cpt-fetch.1 | 11 ++ man/cpt-install.1 | 20 ++++ man/cpt-list.1 | 13 +++ man/cpt-remove.1 | 20 ++++ man/cpt-search.1 | 15 +++ man/cpt-update.1 | 22 ++++ man/cpt.1 | 179 ++++++++++++++++++++++++++++++++ man/kiss-contrib.1 | 126 ----------------------- man/kiss.1 | 271 ------------------------------------------------- 14 files changed, 492 insertions(+), 397 deletions(-) create mode 100644 man/cpt-alternatives.1 create mode 100644 man/cpt-build.1 create mode 100644 man/cpt-checksum.1 create mode 100644 man/cpt-contrib.1 create mode 100644 man/cpt-download.1 create mode 100644 man/cpt-fetch.1 create mode 100644 man/cpt-install.1 create mode 100644 man/cpt-list.1 create mode 100644 man/cpt-remove.1 create mode 100644 man/cpt-search.1 create mode 100644 man/cpt-update.1 create mode 100644 man/cpt.1 delete mode 100644 man/kiss-contrib.1 delete mode 100644 man/kiss.1 diff --git a/man/cpt-alternatives.1 b/man/cpt-alternatives.1 new file mode 100644 index 0000000..16023a6 --- /dev/null +++ b/man/cpt-alternatives.1 @@ -0,0 +1,44 @@ +.TH "cpt-alternatives" "1" "2020-07-24" "CARBS LINUX" "General Commands Manual" +.SH NAME +cpt-alternatives +.SH DESCRIPTION +List and swap to alternatives +.PP +.SH SYNOPSIS +\fBcpt-alternatives\fR [-] [pkg file] + +.SH USAGE +cpt-alternatives can be used to list alternatives (when run without arguments). +It can read from standard input if ('-' is given as an argument). If you want to +otherwise + +.SH EXAMPLES +.nf ++-----------------------------------------------------------------------+ +| List alternatives | ++-----------------------------------------------------------------------+ +| | +| $ kiss a | +| ncurses /usr/bin/clear | +| ncurses /usr/bin/reset | +| | ++-----------------------------------------------------------------------+ +| Swap to 'clear' from ncurses. | ++-----------------------------------------------------------------------+ +| | +| $ kiss a ncurses /usr/bin/clear | +| -> Swapping '/usr/bin/clear' from 'busybox' to 'ncurses' | +| | ++-----------------------------------------------------------------------+ +| Swap in bulk (all of sbase). | ++-----------------------------------------------------------------------+ +| | +| $ kiss a | grep ^sbase | kiss a - | +| | ++-----------------------------------------------------------------------+ +.fi + +.SH LICENSE +See LICENSE for copyright information. +.SH SEE ALSO +cpt(1) diff --git a/man/cpt-build.1 b/man/cpt-build.1 new file mode 100644 index 0000000..3abd44f --- /dev/null +++ b/man/cpt-build.1 @@ -0,0 +1,15 @@ +.TH "cpt-build" "1" "2020-07-24" "CARBS LINUX" "General Commands Manual" +.SH NAME +cpt-build +.PP +.SH SYNOPSIS +\fBcpt-build\fR [pkg...] + +.SH DESCRIPTION +cpt-build will build given packages and their dependencies. If multiple packages +are specified, it will ask to install the packages as well. + +.SH LICENSE +See LICENSE for copyright information. +.SH SEE ALSO +cpt(1) diff --git a/man/cpt-checksum.1 b/man/cpt-checksum.1 new file mode 100644 index 0000000..5c16b36 --- /dev/null +++ b/man/cpt-checksum.1 @@ -0,0 +1,14 @@ +.TH "cpt-checksum" "1" "2020-07-24" "CARBS LINUX" "General Commands Manual" +.SH NAME +cpt-checksum +.SH SYNOPSIS +\fBcpt-checksum\fR [pkg...] + +.SH DESCRIPTION +cpt-checksum lints a package, downloads the sources, and creates a checksum file +including the SHA256 digests of the sources. + +.SH LICENSE +See LICENSE for copyright information. +.SH SEE ALSO +cpt(1) diff --git a/man/cpt-contrib.1 b/man/cpt-contrib.1 new file mode 100644 index 0000000..8a34364 --- /dev/null +++ b/man/cpt-contrib.1 @@ -0,0 +1,126 @@ +.TH CPT-CONTRIB 1 2020-04-04 "CARBS LINUX" "General Commands Manual" +.SH NAME +cpt utilities +.SH DESCRIPTION +This manual page is not for a single program, but for multiple +utilities. Programs are explained in their own sections. They +are listed alphabetically. +.SH CPT-CAT +.B cpt-cat + [file] [file] + +Concatanates a package's files inside the system database. If no file is +specified, it looks for \fBbuild\fR, \fBdepends\fR, \fBsources\fR, and +\fBversion\fR. +.SH CPT-CHBUILD +.B cpt-chbuild + +cpt-chbuild, creates a temporary rootfs, and chroots into it. + +If it doesn't already exist, cpt-chbuild downloads the rootfs tarball to +your cache directory and extracts it into a \fBcarbs-chroot\fR directory. + +It then copies the chroot to a temporary directory, and runs cpt-chroot +to it. It removes the temporary chroot after the user exits. +.SH CPT-CHROOT +.B cpt-chroot + + +Mounts the required devices to the given directory, copies /etc/resolv.conf +from host, and chroots into the given directory. Cleans up after exit. +.SH CPT-DEPENDS +.B cpt-depends + + +Checks the dependencies of an installed package. +.SH CPT-EXPORT +.B cpt-export + + +Exports a package tarball of an installed package. +.SH CPT-FORK +.B cpt-fork + + +Copies the repository directory of the given package to the current working +directory. +.SH CPT-LINK +.B cpt-link +[file] [file] + +Links files from a package in the repository. It looks for the package by +the directory name, but this can be overriden by getting a PKG environment +value. + +.IP \fBExample:\fR +.nf +$ cpt-fork git +forked package to /home/cem/.local/repositories/overrides/git +$ cd git +$ cpt-link checksums version sources +linked /home/cem/.local/repositories/main/core/git/version to /home/cem/.local/repositories/overrides/git/version +linked /home/cem/.local/repositories/main/core/git/sources to /home/cem/.local/repositories/overrides/git/sources +linked /home/cem/.local/repositories/main/core/git/checksums to /home/cem/.local/repositories/overrides/git/checksums +.fi +.PP +.SH CPT-MANIFEST +.B cpt-manifest + + +Prints the manifest file. +.SH CPT-MANIFEST-TREE +.B cpt-manifest-tree + + +Prints the manifest file in a tree view. +.SH CPT-NEW +.B cpt-new + [version] [sources] + +Creates a boilerplate CPT package. +.SH CPT-OUTDATED +.B cpt-outdated + +Checks \fIrepology.org\fR to see if any installed packages are outdated. This +can be used to check if personal packages are outdated. +.SH CPT-OWNS +.B cpt-owns + + +Checks which package has installed the given file. +.SH CPT-READLINK +.B cpt-readlink + + +A 'readlink -f' replacement to be used inside the package manager. +.SH CPT-REPODEPENDS +.B cpt-repodepends + + +Prints the dependencies of the given package as they are defined in the repository. +.SH CPT-RESET +.B cpt-reset + +Removes all packages except the base packages. +.SH CPT-REVDEPENDS +.B cpt-revdepends + + +Prints the packages that depend on the given package. (Reverse dependencies) +.SH CPT-SIZE +.B cpt-size + + +Prints the given package's size, and its individual files. +.SH CPT-STAT +.B cpt-stat + + +Outputs the owner name of a file/directory +.SH CPT-WHICH +.B cpt-which + + +A \fIwhich\fR-like utility for CPT packages. +.SH SEE ALSO +cpt(1) diff --git a/man/cpt-download.1 b/man/cpt-download.1 new file mode 100644 index 0000000..d940936 --- /dev/null +++ b/man/cpt-download.1 @@ -0,0 +1,13 @@ +.TH "cpt-checksum" "1" "2020-07-24" "CARBS LINUX" "General Commands Manual" +.SH NAME +cpt-download +.SH SYNOPSIS +\fBcpt-download\fR [pkg...] + +.SH DESCRIPTION +cpt-download downloads the sources of the given packages + +.SH LICENSE +See LICENSE for copyright information. +.SH SEE ALSO +cpt(1) diff --git a/man/cpt-fetch.1 b/man/cpt-fetch.1 new file mode 100644 index 0000000..b3336b5 --- /dev/null +++ b/man/cpt-fetch.1 @@ -0,0 +1,11 @@ +.TH "cpt-fetch" "1" "2020-07-24" "CARBS LINUX" "General Commands Manual" +.SH NAME +cpt-fetch + +.SH DESCRIPTION +cpt-fetch fetches the repositories stored under the \fI$CPT_PATH\fR variable. + +.SH LICENSE +See LICENSE for copyright information. +.SH SEE ALSO +cpt(1) diff --git a/man/cpt-install.1 b/man/cpt-install.1 new file mode 100644 index 0000000..27ff2c3 --- /dev/null +++ b/man/cpt-install.1 @@ -0,0 +1,20 @@ +.TH "cpt-install" "1" "2020-07-24" "CARBS LINUX" "General Commands Manual" +.SH NAME +cpt-install +.SH SYNOPSIS +\fBcpt-install\fR [options] [pkg...] + +.SH OPTIONS +.TP +\fB--force\fR Force installation +.TP +\fB--root\fR [rootdir] Use an alternate root directory +.PP + +.SH DESCRIPTION +cpt-install installs the given packages. + +.SH LICENSE +See LICENSE for copyright information. +.SH SEE ALSO +cpt(1) diff --git a/man/cpt-list.1 b/man/cpt-list.1 new file mode 100644 index 0000000..8460e90 --- /dev/null +++ b/man/cpt-list.1 @@ -0,0 +1,13 @@ +.TH "cpt-list" "1" "2020-07-24" "CARBS LINUX" "General Commands Manual" +.SH NAME +cpt-list +.SH SYNOPSIS +\fBcpt-list\fR [pkg...] +.SH DESCRIPTION +cpt-list can be used to list all packages or check if the given package is +installed on the system. + +.SH LICENSE +See LICENSE for copyright information. +.SH SEE ALSO +cpt(1) diff --git a/man/cpt-remove.1 b/man/cpt-remove.1 new file mode 100644 index 0000000..78338e8 --- /dev/null +++ b/man/cpt-remove.1 @@ -0,0 +1,20 @@ +.TH "cpt-remove" "1" "2020-07-24" "CARBS LINUX" "General Commands Manual" +.SH NAME +cpt-remove +.SH SYNOPSIS +\fBcpt-remove\fR [options] [pkg...] + +.SH OPTIONS +.TP +\fB--force\fR Force installation +.TP +\fB--root\fR [rootdir] Use an alternate root directory +.PP + +.SH DESCRIPTION +cpt-remove removes the given packages. + +.SH LICENSE +See LICENSE for copyright information. +.SH SEE ALSO +cpt(1) diff --git a/man/cpt-search.1 b/man/cpt-search.1 new file mode 100644 index 0000000..3a2f683 --- /dev/null +++ b/man/cpt-search.1 @@ -0,0 +1,15 @@ +.TH "cpt-search" "1" "2020-07-24" "CARBS LINUX" "General Commands Manual" +.SH NAME +cpt-search +.SH SYNOPSIS +\fBcpt-search\fR [--single] [pkg...] + +.SH DESCRIPTION +cpt-search can be used to search packages. Glob characters can be used in the +search. If the \fI--single\fR option is specified cpt-search will only output +the first match. + +.SH LICENSE +See LICENSE for copyright information. +.SH SEE ALSO +cpt(1) diff --git a/man/cpt-update.1 b/man/cpt-update.1 new file mode 100644 index 0000000..ec1acc6 --- /dev/null +++ b/man/cpt-update.1 @@ -0,0 +1,22 @@ +.TH "cpt-update" "1" "2020-07-24" "CARBS LINUX" "General Commands Manual" +.SH NAME +cpt-update +.SH SYNOPSIS +\fBcpt-update\fR [options] + +.SH OPTIONS +.TP +\fB--download\fR Only download the updates +.TP +\fB--no-fetch\fR Do not refresh the repositories +.TP +\fB--root\fR [rootdir] Use an alternate root directory +.PP + +.SH DESCRIPTION +cpt-update checks for package updates. + +.SH LICENSE +See LICENSE for copyright information. +.SH SEE ALSO +cpt(1) diff --git a/man/cpt.1 b/man/cpt.1 new file mode 100644 index 0000000..3622db9 --- /dev/null +++ b/man/cpt.1 @@ -0,0 +1,179 @@ +.TH "CPT" "1" "2020-04-19" "CARBS LINUX" "General Commands Manual" +.SH NAME +cpt +.SH DESCRIPTION +Package management toolchain for Carbs Linux. +.PP +.SH SYNOPSIS +cpt [extension] +.TP +cpt will run the appropriate cpt-* command based on the arguments. + +. +.fi +. +.SH CUSTOMIZATION +. +The package manager is controlled through environment variables. + +These can be set in your \fI~/.profile\fR or \fI/etc/profile.d\fR +to have the options apply all the time. + +These can also be set in the current shell to have them apply +only for the current session. + +\fBNOTE:\fR The values shown below are the defaults. + +.SS MANAGING REPOSITORIES +. +This works exactly like \fI$PATH\fR (Colon seperated). + +A list of repositories the package manager will use. You can +add your own repositories or remove the default ones. +.IP +.nf +export CPT_PATH=/var/db/cpt/repo/core:/var/db/cpt/repo/extra:/var/db/cpt/repo/xorg +.fi +.PP +.SS FORCE PACKAGE INSTALLATION OR REMOVAL +This can be used to bypass the dependency checks on installation +and removal of packages. + +Set it to \fB'1'\fR to force. + +.IP +.nf +export CPT_FORCE=0 +.fi +.PP +.SS HOOK INTO CPT THROUGH A SCRIPT +This can be used set custom CFLAGS per package, modify builds, +etc. This environment variable must point to a shellscript. + +The script will have the following environment variables set. + +.TP +.B $PKG: +Name of the current package. +.TP +.B $TYPE: +The type of hook (pre-build, post-build, build-fail, pre-install, post-install). +.TP +.B $DEST: +The full path to where 'make install' will put the package. + +.PP +.B SIMPLE EXAMPLE SCRIPT +.nf + +case $TYPE in + pre-build) + case $PKG in + zlib) export CFLAGS="-Os -static" ;; + curl) export CFLAGS="-O3" ;; + esac + ;; + + post-build) + : "${DEST:?DEST is unset}" + + rm -rf "$DEST/usr/share/doc" + rm -rf "$DEST/usr/share/gettext" + ;; +esac +.fi + +export CPT_HOOK=/path/to/script +.SS ROOT DIRECTORY + +Where installed packages will go. You won't ever need +to touch this during normal usage. + +This can be used to have the package manager run in a "fake root". +.IP +export CPT_ROOT=/ +.PP + +.SS KEEPING LOGS +Keep build logs around for successful builds and not just failing ones. +Helpful when debugging. + +Set it to \fB'1'\fR to enable. +.IP +export CPT_KEEPLOG=0 +.PP +.SS KEEPING BUILD FILES +You can keep build, package and extraction cache directories for debugging +purposes. + +Set it to \fB'1'\fR to enable. +.IP +export CPT_DEBUG=0 +.PP +.SS CHANGING COMPRESSION METHOD +\fBCPT\fR by default uses gzip for packaging, but it can be changed. Valid +options are \fIbz2\fR, \fIgz\fR (default), \fIxz\fR, \fIzst\fR. If an unknown +compression method is specified, it fallbacks to \fIgz\fR. +.IP +export CPT_COMPRESS=gz +.PP +.SS SUDO UTILITIES +You can force the usage of a different \fB'sudo'\fR tool. Available options are +\fIsu\fR, \fIsudo\fR, \fIdoas\fR. +.IP +export CPT_SU= +.PP +.SS USE A REPRODUCIBLE CACHE NAMING SCHEME + +The package manager builds packages inside \fIbuild-$PID/\fR with \fI$PID\fR +being the package manager's process ID. This allows for multiple +builds to happen at once. + +You can override this and \fIknow\fR the location beforehand with the +below environment variable. \fICPT_PID=test\fR will build the package +in \fIbuild-test\fR. + +Unset by default. +.IP +export CPT_PID= +.PP +.SS SPECIFYING BUILD DIRECTORY + +All build related files, by default, are stored in the cache directory. If the +user specifies \fICPT_TMPDIR\fR, it will be used instead of the cache directory +for building packages. This can be useful if you want to build a package on ram +or a different filesystem. + +Unset by default. +.IP +export CPT_TMPDIR= +.PP +.SS ENABLING/DISABLING COLOUR + +If run in a subshell, \fBCPT\fR disables colour output. However, this behaviour +can be overriden. If a user defines a \fICPT_COLOR\fR environment value, it will +be enabled or disabled globally +.IP +export CPT_COLOR=1 # Enables globally +.IP +export CPT_COLOR=0 # Disables globally +.PP +.SS DISABLING PROMPTS +User can disable prompts by setting a \fICPT_NOPROMPT\fR environment value. This +can be useful for scripting purposes. + +.IP +CPT_NOPROMPT=1 cpt-build pkg1 pkg2 +.PP + +.SH AUTHORS +Cem Keylan, Fork Maintainer, Carbs Linux +.br + +.PP +Dylan Araps, Original Author of the kiss package manager, KISS Linux + +.SH LICENSE +See LICENSE for copyright information +.SH SEE ALSO +cpt-contrib(1) cpt-alternatives(1) cpt-install(1) rsync(1) diff --git a/man/kiss-contrib.1 b/man/kiss-contrib.1 deleted file mode 100644 index aeeab69..0000000 --- a/man/kiss-contrib.1 +++ /dev/null @@ -1,126 +0,0 @@ -.TH KISS-CONTRIB 1 2020-04-04 "CARBS LINUX" "General Commands Manual" -.SH NAME -kiss utilities -.SH DESCRIPTION -This manual page is not for a single program, but for multiple -utilities. Programs are explained in their own sections. They -are listed alphabetically. -.SH KISS-CAT -.B kiss-cat - [file] [file] - -Concatanates a package's files inside the system database. If no file is -specified, it looks for \fBbuild\fR, \fBdepends\fR, \fBsources\fR, and -\fBversion\fR. -.SH KISS-CHBUILD -.B kiss-chbuild - -kiss-chbuild, creates a temporary rootfs, and chroots into it. - -If it doesn't already exist, kiss-chbuild downloads the rootfs tarball to -your cache directory and extracts it into a \fBcarbs-chroot\fR directory. - -It then copies the chroot to a temporary directory, and runs kiss-chroot -to it. It removes the temporary chroot after the user exits. -.SH KISS-CHROOT -.B kiss-chroot - - -Mounts the required devices to the given directory, copies /etc/resolv.conf -from host, and chroots into the given directory. Cleans up after exit. -.SH KISS-DEPENDS -.B kiss-depends - - -Checks the dependencies of an installed package. -.SH KISS-EXPORT -.B kiss-export - - -Exports a package tarball of an installed package. -.SH KISS-FORK -.B kiss-fork - - -Copies the repository directory of the given package to the current working -directory. -.SH KISS-LINK -.B kiss-link -[file] [file] - -Links files from a package in the repository. It looks for the package by -the directory name, but this can be overriden by getting a PKG environment -value. - -.IP \fBExample:\fR -.nf -$ kiss-fork git -forked package to /home/cem/.local/repositories/overrides/git -$ cd git -$ kiss-link checksums version sources -linked /home/cem/.local/repositories/main/core/git/version to /home/cem/.local/repositories/overrides/git/version -linked /home/cem/.local/repositories/main/core/git/sources to /home/cem/.local/repositories/overrides/git/sources -linked /home/cem/.local/repositories/main/core/git/checksums to /home/cem/.local/repositories/overrides/git/checksums -.fi -.PP -.SH KISS-MANIFEST -.B kiss-manifest - - -Prints the manifest file. -.SH KISS-MANIFEST-TREE -.B kiss-manifest-tree - - -Prints the manifest file in a tree view. -.SH KISS-NEW -.B kiss-new - [version] [sources] - -Creates a boilerplate KISS package. -.SH KISS-OUTDATED -.B kiss-outdated - -Checks \fIrepology.org\fR to see if any installed packages are outdated. This -can be used to check if personal packages are outdated. -.SH KISS-OWNS -.B kiss-owns - - -Checks which package has installed the given file. -.SH KISS-READLINK -.B kiss-readlink - - -A 'readlink -f' replacement to be used inside the package manager. -.SH KISS-REPODEPENDS -.B kiss-repodepends - - -Prints the dependencies of the given package as they are defined in the repository. -.SH KISS-RESET -.B kiss-reset - -Removes all packages except the base packages. -.SH KISS-REVDEPENDS -.B kiss-revdepends - - -Prints the packages that depend on the given package. (Reverse dependencies) -.SH KISS-SIZE -.B kiss-size - - -Prints the given package's size, and its individual files. -.SH KISS-STAT -.B kiss-stat - - -Outputs the owner name of a file/directory -.SH KISS-WHICH -.B kiss-which - - -A \fIwhich\fR-like utility for KISS packages. -.SH SEE ALSO -kiss(1) diff --git a/man/kiss.1 b/man/kiss.1 deleted file mode 100644 index 318eb20..0000000 --- a/man/kiss.1 +++ /dev/null @@ -1,271 +0,0 @@ -.TH KISS "1" "2020-04-19" "CARBS LINUX" "General Commands Manual" -.SH NAME -kiss -.SH DESCRIPTION -Tiny and straightforward package manager for Carbs Linux -written in POSIX sh. Forked from KISS Linux. -.PP -.SH SYNOPSIS -.IP kiss -[a|b|c|d|e|f|i|l|r|s|u|v] [pkg] [pkg] [pkg] -.PP -.SH OPTIONS -.TP -\fBalternatives\fR List and swap to alternatives -.TP -\fBbuild\fR Build a package -.TP -\fBchecksum\fR Generate checksums -.TP -\fBdownload\fR Download sources for the given package -.TP -\fBextension\fR List available kiss extensions -.TP -\fBfetch\fR Fetch repositories -.TP -\fBinstall\fR Install a package -.TP -\fBlist\fR List installed packages -.TP -\fBremove\fR Remove a package -.TP -\fBsearch\fR Search for a package -.TP -\fBupdate\fR Check for updates -.TP -\fBversion\fR Package manager version -.PP - -. -.fi -. -.SH CUSTOMIZATION -. -The package manager is controlled through environment variables. - -These can be set in your \fI~/.profile\fR or \fI/etc/profile.d\fR -to have the options apply all the time. - -These can also be set in the current shell to have them apply -only for the current session. - -\fBNOTE:\fR The values shown below are the defaults. - -.SS MANAGING REPOSITORIES -. -This works exactly like \fI$PATH\fR (Colon seperated). - -A list of repositories the package manager will use. You can -add your own repositories or remove the default ones. -.IP -.nf -export KISS_PATH=/var/db/kiss/repo/core:/var/db/kiss/repo/extra:/var/db/kiss/repo/xorg -.fi -.PP -.SS FORCE PACKAGE INSTALLATION OR REMOVAL -This can be used to bypass the dependency checks on installation -and removal of packages. - -Set it to \fB'1'\fR to force. - -.IP -.nf -export KISS_FORCE=0 -.fi -.PP -.SS HOOK INTO KISS THROUGH A SCRIPT -This can be used set custom CFLAGS per package, modify builds, -etc. This environment variable must point to a shellscript. - -The script will have the following environment variables set. - -.TP -.B $PKG: -Name of the current package. -.TP -.B $TYPE: -The type of hook (pre-build, post-build, build-fail, pre-install, post-install). -.TP -.B $DEST: -The full path to where 'make install' will put the package. - -.PP -.B SIMPLE EXAMPLE SCRIPT -.nf - -case $TYPE in - pre-build) - case $PKG in - zlib) export CFLAGS="-Os -static" ;; - curl) export CFLAGS="-O3" ;; - esac - ;; - - post-build) - : "${DEST:?DEST is unset}" - - rm -rf "$DEST/usr/share/doc" - rm -rf "$DEST/usr/share/gettext" - ;; -esac -.fi - -export KISS_HOOK=/path/to/script -.SS ROOT DIRECTORY - -Where installed packages will go. You won't ever need -to touch this during normal usage. - -This can be used to have the package manager run in a "fake root". -.IP -export KISS_ROOT=/ -.PP - -.SS KEEPING LOGS -Keep build logs around for successful builds and not just failing ones. -Helpful when debugging. - -Set it to \fB'1'\fR to enable. -.IP -export KISS_KEEPLOG=0 -.PP -.SS KEEPING BUILD FILES -You can keep build, package and extraction cache directories for debugging -purposes. - -Set it to \fB'1'\fR to enable. -.IP -export KISS_DEBUG=0 -.PP -.SS CHANGING COMPRESSION METHOD -\fBKISS\fR by default uses gzip for packaging, but it can be changed. Valid -options are \fIbz2\fR, \fIgz\fR (default), \fIxz\fR, \fIzst\fR. If an unknown -compression method is specified, it fallbacks to \fIgz\fR. -.IP -export KISS_COMPRESS=gz -.PP -.SS SUDO UTILITIES -You can force the usage of a different \fB'sudo'\fR tool. Available options are -\fIsu\fR, \fIsudo\fR, \fIdoas\fR. -.IP -export KISS_SU= -.PP -.SS USE A REPRODUCIBLE CACHE NAMING SCHEME - -The package manager builds packages inside \fIbuild-$PID/\fR with \fI$PID\fR -being the package manager's process ID. This allows for multiple -builds to happen at once. - -You can override this and \fIknow\fR the location beforehand with the -below environment variable. \fIKISS_PID=test\fR will build the package -in \fIbuild-test\fR. - -Unset by default. -.IP -export KISS_PID= -.PP -.SS SPECIFYING BUILD DIRECTORY - -All build related files, by default, are stored in the cache directory. If the -user specifies \fIKISS_TMPDIR\fR, it will be used instead of the cache directory -for building packages. This can be useful if you want to build a package on ram -or a different filesystem. - -Unset by default. -.IP -export KISS_TMPDIR= -.PP -.SS ENABLING/DISABLING COLOUR - -If run in a subshell, \fBKISS\fR disables colour output. However, this behaviour -can be overriden. If a user defines a \fIKISS_COLOR\fR environment value, it will -be enabled or disabled globally -.IP -export KISS_COLOR=1 # Enables globally -.IP -export KISS_COLOR=0 # Disables globally -.PP -.SS DISABLING PROMPTS -User can disable prompts by setting a \fIKISS_NOPROMPT\fR environment value. This -can be useful for scripting purposes. - -.IP -KISS_NOPROMPT=1 kiss b pkg1 pkg2 -.PP -.SH ALTERNATIVES SYSTEM -When a package with conflicts is installed the conflicting -files will be added as "choices" to the alternatives system. - -Afterwards, running kiss a/kiss alternatives will list all of -the choices you are able to make. Each line of output with this -command is also usable directly as input. - -\fBNOTE:\fR To disable this functionality, set 'KISS_CHOICE=0'. - -.SS EXAMPLE USAGE -.nf -# List alternatives. --> kiss a --> Alternatives: -ncurses /usr/bin/clear -ncurses /usr/bin/reset - -# Swap to ncurses 'clear'. --> kiss a ncurses /usr/bin/clear --> Swapping '/usr/bin/clear' from 'busybox' to 'ncurses' -Password: - -# New listing (busybox clear was swapped out). --> kiss a --> Alternatives: -busybox /usr/bin/clear -ncurses /usr/bin/reset - -Example usage (complex): - --> kiss i sbase -# More lines... --> sbase Found conflict (/usr/bin/renice), adding choice --> sbase Found conflict (/usr/bin/logger), adding choice --> sbase Found conflict (/usr/bin/flock), adding choice --> sbase Found conflict (/usr/bin/cal), adding choice --> sbase Installing package incrementally --> sbase Installed successfully - -# List alternatives. --> kiss a -# More lines... -sbase /usr/bin/uuencode -sbase /usr/bin/wc -sbase /usr/bin/which -sbase /usr/bin/whoami -sbase /usr/bin/xargs -sbase /usr/bin/yes - -# Swapping in bulk (all of sbase). -# The 'kiss a' command with '-' as an argument will read -# from stdin and use each line as arguments to 'kiss a'. -kiss a | grep ^sbase | kiss a - - -# New listing, sbase has replaced busybox utilities. --> kiss a -# More lines... -busybox /usr/bin/uuencode -busybox /usr/bin/wc -busybox /usr/bin/which -busybox /usr/bin/whoami -busybox /usr/bin/xargs -busybox /usr/bin/yes -.fi - -.SH AUTHORS -Cem Keylan, Fork Maintainer, Carbs Linux -.br - -.PP -Dylan Araps, Original Author, KISS Linux - -.SH LICENSE -See LICENSE for copyright information -.SH SEE ALSO -kiss-contrib(1) -- cgit v1.2.3