pacwrap/pacwrap
pacwrap/pacwrap
1
0
Fork 0
Code Issues Activity Actions

Applied 9b495390d2

Browse source
This commit is contained in:
Xavier Moffett 2024-01-14 21:40:15 -05:00
parent ff70ac644b
commit 8998fd4839
1 changed files with 29 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
docs/manual.md
View file

@ -1,6 +1,6 @@
# Pacwrap User Manual # Pacwrap User Manual
This document was generated by the pacwrap binary on 17/11/2023 00:49:30 with version 0.5.0-b9b5ea8 of the program. This document was generated by the pacwrap binary on 14/01/2024 with version 0.6.0-ff70ac6 of the program.
## NAME ## NAME
pacwrap - Command-line application which facilitates the creation, management, and execution of unprivileged, pacwrap - Command-line application which facilitates the creation, management, and execution of unprivileged,
@ -44,7 +44,7 @@ Synchronize remote package databases. Specify up to 2 times to force a refresh.
* **-u, --upgrade** * **-u, --upgrade**
Execute aggregate upgrade routine on all or specified containers. Use **-t, --target=TARGET** to limit Execute aggregate upgrade routine on all or specified containers. Use **-t, --target=TARGET** to limit
package synhronization operations to the specified target containers. Packages applicable to package synchronization operations to the specified target containers. Packages applicable to
a target **must** be specified only after the target operand. a target **must** be specified only after the target operand.
e.g. '-t electron element-desktop -t mozilla firefox thunderbird' e.g. '-t electron element-desktop -t mozilla firefox thunderbird'
@ -58,27 +58,37 @@ Create a container with the first specified target. A container type argument is
* **-b, --base** * **-b, --base**
Base container type. Specify alongside **-c, --create** to assign this container type during creation. Base container type. Specify alongside **-c, --create** to assign this container type during creation.
This container type is used as the base layer for all downstream containers. Only one base container This container type is used as the base layer for all downstream containers. Only one base container
dependency per slice or per root is supported. Filesystem and package deduplication via slices dependency per slice or aggregate is supported. Filesystem and package deduplication via slices and
and root containers is recommended, but optional. aggregate containers are recommended, but optional.
* **-d, --slice** * **-s, --slice**
Slice container type. Specify alongside **-c, --create** to assign this container type during creation. Slice container type. Specify alongside **-c, --create** to assign this container type during creation.
Requires a base dependency target, and optionally sliced dependency target(s), in order to ascertain
foreign packages and influence ordering of downstream synchronization target(s). Container slicing
provides the ability to install packages in a lightweight, sliced filesytem, which aid in the
deduplication of common downstream package and filesystem dependencies e.g. graphics drivers,
graphical toolkits, fonts, etc..
* **-r, --root** Requires a base dependency, and optionally one or more sliced dependencies, to ascertain foreign
Root container type. Specify alongside **-c, --create** to this assign container type during creation. packages and influence ordering of downstream synchronization target(s). Container slicing provies
Requires a base dependency target, and optionally sliced dependency targets, in order to ascertain the ability to install packages in a lightweight, sliced filesytem, which aid in the deduplication
foreign packages and influence ordering of this target. These containers are ideal for installing of common downstream package and filesystem dependencies.
software in with the least amount of filesystem and package synchronization overhead.
Useful for graphics drivers, graphical toolkits, fonts, etc.; these are not meant for applications.
* **-a, --aggegrate**
Aggregate container type. Specify alongside **-c, --create** to this assign container type during creation.
Requires a base dependency, and optionally one or more sliced dependencies, in order to acertain foreign
packages and amalgamate the target. These containers are ideal for installing software with the aid of
filesystem and package deduplication.
Useful for all general purpose applications, browsers, e-mail clients, and even terminal user interface
applications such as IRC clients. It is recommended to base your containers on aggregate type containers.
* **-t, --target=TARGET** * **-t, --target=TARGET**
Specify a target container for the specified operation. Specify a target container for the specified operation.
* **-d, --dep=DEPEND**
Specify a dependent container for the specified operation.
* **-o, --target-only** * **-o, --target-only**
Apply specified operation on the specified target only. Apply specified operation on the specified target only.
@ -118,13 +128,13 @@ Display all help topics.
Sends version information to **STDOUT** with colourful ASCII art. Sends version information to **STDOUT** with colourful ASCII art.
The 'min' option provides a minimalistic output as is provided to non-colour terms. The 'min' option provides a minimalistic output as is provided to non-colour terms.
This documentation was generated by pacwrap v0.5.0-b9b5ea8-DEV (17/11/2023 00:49:30). This documentation was generated by pacwrap v0.6.0-ff70ac6-RELEASE (14/01/2024).
Please seek relevant documentation if 'pacwrap -V' mismatches with the aforementioned. Please seek relevant documentation if 'pacwrap -V' mismatches with the aforementioned.
## COPYRIGHT ## COPYRIGHT
Copyright (C) 2023 - Xavier R.M. Copyright (C) 2023-2024 Xavier R.M.
This program may be freely redistributed under This program may be freely redistributed under the
the terms of the GNU General Public License v3. terms of the GNU General Public License v3 only.