update manual pages

FossilOrigin-Name: e053d099bc1dc54208956ffdae0899d8b6c5a6f60892ea5d56c1e1ebe1dbd544

10 files changed, 341 insertions, 341 deletions

diff --git a/man/cpt-alternatives.1 b/man/cpt-alternatives.1
index 8ae073d..8196b40 100644
--- a/man/cpt-alternatives.1
+++ b/man/cpt-alternatives.1
@@ -1,44 +1,59 @@
-.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                                                     |
-+-----------------------------------------------------------------------+
-|                                                                       |
-| $ cpt-alternatives                                                    |
-| ncurses /usr/bin/clear                                                |
-| ncurses /usr/bin/reset                                                |
-|                                                                       |
-+-----------------------------------------------------------------------+
-| Swap to 'clear' from ncurses.                                         |
-+-----------------------------------------------------------------------+
-|                                                                       |
-| $ cpt-alternatives ncurses /usr/bin/clear                             |
-| -> Swapping '/usr/bin/clear' from 'busybox' to 'ncurses'              |
-|                                                                       |
-+-----------------------------------------------------------------------+
-| Swap in bulk (all of sbase).                                          |
-+-----------------------------------------------------------------------+
-|                                                                       |
-| $ cpt-alternatives | grep ^sbase | cpt-alternatives -                 |
-|                                                                       |
-+-----------------------------------------------------------------------+
-.fi
-
-.SH LICENSE
+.Dd Feb 25, 2021
+.Dt cpt-alternatives 1
+.Sh NAME
+.Nm cpt-alternatives
+.Nd List and swap to alternatives
+.Sh SYNOPSIS
+.Nm cpt-alternatives
+.Op Ar -
+.Op Ar package file
+.Sh USAGE
+.Nm
+can be used to either list or swap to alternatives, depending on the given
+arguments:
+.Bl -tag -offset indent -width 12n
+.It Sy -
+Swap to alternatives given on the standard input.
+.It Sy none
+List alternatives.
+.It Sy pkg file
+Swap to the alternative
+.Sy file
+from
+.Sy pkg
+.El
+.Sh EXAMPLES
+.Pp
+Here are some sample commands to make it easier to understand how
+.Nm
+works.
+.Ss LISTING ALTERNATIVES
+.Pp
+Calling
+.Nm
+without any arguments will print all available alternatives on your system.
+.Bd -literal -offset indent
+$ cpt-alternatives
+ncurses /usr/bin/clear
+ncurses /usr/bin/reset
+.Ed
+.Ss SWITCHING ALTERNATIVES
+You can simply switch between alternatives by giving the name of the package and
+the file as arguments.
+.Bd -literal -offset indent
+$ cpt-alternatives ncurses /usr/bin/clear
+-> Swapping '/usr/bin/clear' from 'busybox' to 'ncurses'
+.Ed
+.Ss SWITCHING ALTERNATIVES IN BULK
+There may be times where you want to change multiple alternatives at once. Here
+is an example for using all alternatives from the package
+.Sy sbase .
+.Bd -literal -offset indent
+$ cpt-alternatives | grep ^sbase | cpt-alternatives -
+.Ed
+.Sh AUTHOR
+.An Cem Keylan Aq Mt cem@ckyln.com
+.Sh LICENSE
 See LICENSE for copyright information.
-.SH SEE ALSO
-cpt(1)
+.Sh SEE ALSO
+.Xr cpt 1
diff --git a/man/cpt-build.1 b/man/cpt-build.1
index 3abd44f..d7d89e0 100644
--- a/man/cpt-build.1
+++ b/man/cpt-build.1
@@ -1,15 +1,37 @@
-.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
+.Dd Feb 25, 2021
+.Dt cpt-build 1
+.Sh NAME
+.Nm cpt-build
+.Nd build given packages
+.Sh SYNOPSIS
+.Nm cpt-build
+.Op Fl tfy
+.Op Fl -root Ar ROOT
+.Op Fl hv
+.Op Ar package...
+.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
+.Pp
+The options are as follows:
+.Bl -tag -width 13n
+.It Fl t , -test
+Run tests (if they exist)
+.It Fl f , -force
+Force operation
+.It Fl y , -no-prompt
+Do not prompt for confirmation
+.It Fl -root Ar CPT_ROOT
+Use an alternate root directory
+.It Fl h , -help
+Show help message
+.It Fl v , -version
+Print version information
+.El
+.Sh AUTHOR
+.An Cem Keylan Aq Mt cem@ckyln.com
+.Sh LICENSE
 See LICENSE for copyright information.
-.SH SEE ALSO
-cpt(1)
+.Sh SEE ALSO
+.Xr cpt 1
+.Xr cpt-install 1
diff --git a/man/cpt-checksum.1 b/man/cpt-checksum.1
index 5c16b36..eb684df 100644
--- a/man/cpt-checksum.1
+++ b/man/cpt-checksum.1
@@ -1,14 +1,17 @@
-.TH "cpt-checksum" "1" "2020-07-24" "CARBS LINUX" "General Commands Manual"
-.SH NAME
-cpt-checksum
-.SH SYNOPSIS
-\fBcpt-checksum\fR [pkg...]
-
-.SH DESCRIPTION
+.Dd Feb 25, 2021
+.Dt cpt-checksum 1
+.Sh NAME
+.Nm cpt-checksum
+.Nd generate checksums
+.Sh SYNOPSIS
+.Nm
+.Op Ar package...
+.Sh DESCRIPTION
 cpt-checksum lints a package, downloads the sources, and creates a checksum file
 including the SHA256 digests of the sources.
-
-.SH LICENSE
+.Sh AUTHOR
+.An Cem Keylan Aq Mt cem@ckyln.com
+.Sh LICENSE
 See LICENSE for copyright information.
-.SH SEE ALSO
-cpt(1)
+.Sh SEE ALSO
+.Xr cpt 1
diff --git a/man/cpt-download.1 b/man/cpt-download.1
index d940936..660ba8c 100644
--- a/man/cpt-download.1
+++ b/man/cpt-download.1
@@ -1,13 +1,18 @@
-.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
+.Dd Feb 25, 2021
+.Dt cpt-download 1
+.Sh NAME
+.Nm cpt-download
+.Nd download sources for given packages
+.Sh SYNOPSIS
+.Nm
+.Op Ar pkg...
+.Sh DESCRIPTION
+cpt-download downloads the sources of the given packages. If no arguments are
+specified, it will assume that the current directory is the package.
+.Sh AUTHOR
+.An Cem Keylan Aq Mt cem@ckyln.com
+.Sh LICENSE
 See LICENSE for copyright information.
-.SH SEE ALSO
-cpt(1)
+.Sh SEE ALSO
+.Xr cpt 1
+.Xr cpt-checksum 1
diff --git a/man/cpt-install.1 b/man/cpt-install.1
index 27ff2c3..65069f3 100644
--- a/man/cpt-install.1
+++ b/man/cpt-install.1
@@ -1,20 +1,39 @@
-.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
+.Dd Feb 25, 2021
+.Dt cpt-install 1
+.Sh NAME
+.Nm cpt-install
+.Nd install given packages
+.Sh SYNOPSIS
+.Nm
+.Op Fl fy
+.Op Fl -root Ar CPT_ROOT
+.Op Ar package...
+.Sh DESCRIPTION
+.Nm
+installs given packages. It will assume that the current directory is a package
+if no arguments are given. Before
+.Nm
+can install a package it must be built by using the
+.Xr cpt-build 1
+tool.
+.Pp
+The options are as follows:
+.Bl -tag -width 15n
+.It Fl f , -force
+Force installation
+.It Fl y , -no-prompt
+Do not prompt for confirmation
+.It Fl -root Ar CPT_ROOT
+Use an alternate root directory
+.It Fl h , -help
+Show help message
+.It Fl v , -version
+Print version information
+.El
+.Sh AUTHOR
+.An Cem Keylan Aq Mt cem@ckyln.com
+.Sh LICENSE
 See LICENSE for copyright information.
-.SH SEE ALSO
-cpt(1)
+.Sh SEE ALSO
+.Xr cpt 1
+.Xr cpt-build 1
diff --git a/man/cpt-list.1 b/man/cpt-list.1
index 8460e90..16a2959 100644
--- a/man/cpt-list.1
+++ b/man/cpt-list.1
@@ -1,13 +1,44 @@
-.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
+.Dd Feb 25, 2021
+.Dt cpt-list 1
+.Sh NAME
+.Nm cpt-list
+.Nd list packages
+.Sh SYNOPSIS
+.Nm
+.Op Fl c
+.Op Fl -check Ar args...
+.Op Ar pkg...
+.Sh DESCRIPTION
+.Nm
+can be used to list all packages or check if the given package is
+installed on the system. Without any arguments supplied,
+.Nm
+will list all packages installed on the system. Otherwise, it will check and
+list the given packages. If any of the given packages are not installed on the
+system,
+.Nm
+will exit with an error. However,
+.Fl c
+and
+.Fl -check
+flags can be used in order to change the behaviour of the utility:
+.Bl -tag -width 12n
+.It Fl c , -current
+Assumes that the current directory is a package and will use it instead of
+arguments.
+.It Fl -check Ar package true_statement false_statement
+Checks whether the
+.Em package
+is installed on the system and returns the string for
+.Em true_statement
+if it is installed and the string for
+.Em false_statement
+if it isn't. This function is mostly useful for being called inside packages for
+optional dependencies.
+.El
+.Sh AUTHOR
+.An Cem Keylan Aq Mt cem@ckyln.com
+.Sh LICENSE
 See LICENSE for copyright information.
-.SH SEE ALSO
-cpt(1)
+.Sh SEE ALSO
+.Xr cpt 1
diff --git a/man/cpt-remove.1 b/man/cpt-remove.1
index 78338e8..f4bb6fb 100644
--- a/man/cpt-remove.1
+++ b/man/cpt-remove.1
@@ -1,20 +1,37 @@
-.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
+.Dd Feb 25, 2021
+.Dt cpt-remove 1
+.Sh NAME
+.Nm cpt-remove
+.Nd remove given packages from the system
+.Sh SYNOPSIS
+.Nm
+.Op Fl fy
+.Op Fl -root Ar CPT_ROOT
+.Op Ar package...
+.Sh DESCRIPTION
+.Nm
+can be used to remove given packages from the system. If no arguments are
+supplied,
+.Nm
+will assume that the current directory is the package.
+.Pp
+The options are as follows:
+.Bl -tag -width 14n
+.It Fl f , -force
+Force removal
+.It Fl y , -no-prompt
+Do not prompt for confirmation
+.It Fl -root Ar CPT_ROOT
+Use an alternate root directory
+.It Fl h , -help
+Show help message
+.It Fl v , -version
+Print version information
+.El
+.Sh AUTHOR
+.An Cem Keylan Aq Mt cem@ckyln.com
+.Sh LICENSE
 See LICENSE for copyright information.
-.SH SEE ALSO
-cpt(1)
+.Sh SEE ALSO
+.Xr cpt 1
+.Xr cpt-install 1
diff --git a/man/cpt-search.1 b/man/cpt-search.1
index 3a2f683..b20547e 100644
--- a/man/cpt-search.1
+++ b/man/cpt-search.1
@@ -1,15 +1,33 @@
-.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
+.Dd Feb 25, 2021
+.Dt cpt-search 1
+.Sh NAME
+.Nm cpt-search
+.Nd search for cpt packages
+.Sh SYNOPSIS
+.Nm
+.Op Fl dso
+.Op Ar query
+.Sh DESCRIPTION
+.Nm
+can be used to search packages. Glob characters can also be used in the search.
+.Pp
+The options are as follows:
+.Bl -tag -width 14n
+.It Fl d
+Do not search the installed package database.
+.It Fl s , -single
+Only show the first instance of a package.
+.It Fl o , -others
+Use the current directory as the package and show other instances of that
+package.
+.It Fl h , -help
+Show help message
+.It Fl v , -version
+Print version information
+.El
+.Sh AUTHOR
+.An Cem Keylan Aq Mt cem@ckyln.com
+.Sh LICENSE
 See LICENSE for copyright information.
-.SH SEE ALSO
-cpt(1)
+.Sh SEE ALSO
+.Xr cpt 1
diff --git a/man/cpt-update.1 b/man/cpt-update.1
index ec1acc6..3af1205 100644
--- a/man/cpt-update.1
+++ b/man/cpt-update.1
@@ -1,22 +1,40 @@
-.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
+.Dd Feb 25, 2021
+.Dt cpt-update 1
+.Sh NAME
+.Nm cpt-update
+.Nd update installed packages
+.Sh SYNOPSIS
+.Nm
+.Op Fl dfnoy
+.Op Fl -root Ar CPT_ROOT
+.Sh DESCRIPTION
+.Nm
+can be used to fetch package repositories, update packages, and download the
+sources for updatable packages.
+.Pp
+The options are as follows:
+.Bl -tag -width 16n
+.It Fl d , -download
+Only download updatable packages
+.It Fl n , -no-fetch
+Do not fetch the repositories
+.It Fl o , -only-fetch
+Only fetch repositories and exit
+.It Fl f , -force
+Force operation
+.It Fl y , -no-prompt
+Do not prompt for confirmation
+.It Fl -root Ar CPT_ROOT
+Use an alternate root directory
+.It Fl h , -help
+Show help message
+.It Fl v , -version
+Print version information
+.El
+.Sh AUTHOR
+.An Cem Keylan Aq Mt cem@ckyln.com
+.Sh LICENSE
 See LICENSE for copyright information.
-.SH SEE ALSO
-cpt(1)
+.Sh SEE ALSO
+.Xr cpt 1
+.Xr cpt-install 1
diff --git a/man/cpt.1 b/man/cpt.1
index 3622db9..54d0e0d 100644
--- a/man/cpt.1
+++ b/man/cpt.1
@@ -1,179 +1,31 @@
-.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
-<cem@ckyln.com>
-.PP
-Dylan Araps, Original Author of the kiss package manager, KISS Linux
-
-.SH LICENSE
+.Dd Feb 25, 2021
+.Dt cpt 1
+.Sh NAME
+.Nm cpt
+.Nd carbs packaging toolchain
+.Sh SYNOPSIS
+.Nm
+.Op Ar extension arg...
+.Sh DESCRIPTION
+.Nm
+is the packaging toolchain written for Carbs Linux. The base command
+.Nm
+will find and run the appropriate
+.Em cpt-*
+command based on the arguments.
+.Pp
+Each base tool have their own manual page and concise documentation can be found
+on GNU info pages, either using the
+.Xr info 1
+program or through the web from
+.Lk https://carbslinux.org/docs.html .
+It can also be read plaintext by running
+.Pp
+.Dl less Pa /usr/share/doc/cpt.txt
+.Sh AUTHOR
+.An Cem Keylan Aq Mt cem@ckyln.com
+.Sh LICENSE
 See LICENSE for copyright information
-.SH SEE ALSO
-cpt-contrib(1) cpt-alternatives(1) cpt-install(1) rsync(1)
+.Sh SEE ALSO
+.Xr cpt-build 1
+.Xr cpt-install 1