tRefresh manpages with examples and up to date information - pm - barely a pack manager
HTML git clone git://z3bra.org/pm
DIR Log
DIR Files
DIR Refs
DIR README
DIR LICENSE
---
DIR commit 0c8ca85a678fa09457671f953c91c76a732aafc0
DIR parent 2619ec20294d69b06bba8d1351f06e4d267eac29
HTML Author: Willy Goiffon <dev@z3bra.org>
Date: Tue, 2 Jun 2020 11:56:50 +0200
Refresh manpages with examples and up to date information
Diffstat:
M pack.5 | 22 +++++++++-------------
M pm.1 | 49 ++++++++++++++++++++++++-------
2 files changed, 48 insertions(+), 23 deletions(-)
---
DIR diff --git a/pack.5 b/pack.5
t@@ -45,24 +45,20 @@ share/man/man1/pm.1
share/man/man5/
share/man/man5/pack.5
.Ed
-.Sh USAGE
+.Sh EXAMPLE
In order to create a pack suitable for use with
.Xr pm 1 ,
you can use external tools to first install your pack into a specific
-directory, change to this directory and archive its content. Files having
-a newline character ('\n') in their name are not supported by
-.Xr pm 1 .
-The typical workflow to create packs would be the following:
-.Bd -literal -offset indent
-make
-make DESTDIR=/tmp/rootfs install
-cd /tmp/rootfs
-tar -c $(ls) | bzip2 > /tmp/pm@0.0.tbz
+directory, change to this directory and archive its content.
+.Bd -literal
+ make
+ make DESTDIR=$PWD/tmproot PREFIX= install
+ tar -C ./tmproot -f /tmp/pm@1.3.tbz -cj .
.Ed
.Pp
-You can check the content of this pack with:
-.Bd -literal -offset indent
-bzip2 -cd < /tmp/pm@0.0.tbz | tar -t
+You can then check the content of this pack with:
+.Bd -literal
+ tar -f /tmp/pm@1.3.tbz -tj
.Ed
.Sh SEE ALSO
.Xr pm 1 ,
DIR diff --git a/pm.1 b/pm.1
t@@ -20,15 +20,18 @@ flag)
.It Fl d Ar <arg>
Delete a pack from the system based on informations loaded from either a
filename or a pack name. In case of a pack name, the information is loaded
-from $ROOT/var/pm/<arg>
+from $DATA/<arg>
.It Fl u Ar <file>
-Update pack(s) by first deleting it, and reinstalling it
+Update pack by first deleting it, and reinstalling it. If the version
+of the pack provided is the same as the installed one, do nothing.
.It Fl i Ar [name]
-If a name is provided, dump the content of $ROOT/var/pm/<name>/files to stdout.
-Otherwise, list all packs installed on the system along with their version
-number
+If a name is provided, print the list of files installed for
+.Em name .
+Otherwise, list all packs installed on the system (increase verbosity with
+.Fl v
+to see the version).
.It Fl v
-Increase verbosity. There are three levels of logging, as follow:
+Increase verbosity by one level. There are three levels of logging, as follow:
.Bl -enum -compact
.It
write out which action has been done (INFO)
t@@ -37,21 +40,47 @@ detail all tasks being executed (VERBOSE)
.It
report every change made to the filesystem (DEBUG)
.El
-The logging level can be increased by passing the verbose flag (-v) again.
+.Pp
Each level includes the messages of the previous ones.
.It Fl f
Force overwriting files during installation. This shouldn't be needed, so take
extra care when using it.
.El
+.Sh EXAMPLES
+To install a pack to
+.Pa ~/.local ,
+upgrade and then delete it:
+.Bd -literal
+ export ROOT=~/.local
+ export DATA=~/.cache/pmdb
+
+ pm -a name@1.0.tbz
+ pm -u name@1.1.tbz
+ pm -d name
+.Ed
+.Pp
+See
+.Xr pack 5
+for details on how to create a valid pack.
+.Pp
+To get a list of packs installed, and their current version can be inspected
+with the
+.Fl i
+switch. The files installed by a pack are listed if a name is provided.
+.Bd -literal
+ pm -iv
+ pm -i name
+
+.Ed
.Sh ENVIRONMENT
.Bl -tag -width "ROOT"
.It Ev ROOT
Specifies the directory to use as the rootfs for packs installation
-(default: /)
+(default: /).
+.It Ev DATA
+Directory where the pack metadata will be stored (default: /var/db/pm).
.El
.Sh SEE ALSO
.Xr pack 5 ,
-.Xr tar 1 ,
-.Xr bzip2 1
.Sh AUTHORS
.An Willy Goiffon Aq Mt dev@z3bra.org
\ No newline at end of file