pm

commit 2d71b9badf0ab941550001f59271aafe774fe02f
parent 3b59263f722c3563ee2ada172ac94532c5afe28c
Author: z3bra <willyatmailoodotorg>
Date:   Tue May  3 00:06:34 +12000

Add a manpage for the pack format

Diffstat:
pack.5
 | 
58
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 58 insertions(+), 0 deletions(-)
diff --git a/pack.5 b/pack.5
@@ -0,0 +1,58 @@
+.Dd 2016-01-13
+.Dt PACK 5
+.Os POSIX.1-2008
+.Sh NAME
+.Nm pack
+.Nd pack file format
+.Sh DESCRIPTION
+.Nm
+is the name given to compressed archives used by
+.Xr pm 1
+to install softwares under a directory.
+.Ss FILENAME
+The pack name is used to extract informations about it content, and should
+follow a strict naming scheme:
+.Pa <name>#<version>.tar.bz2
+.Ss ARCHIVE FORMAT
+A pack is a
+.Em bzip2
+compressed
+.Em tar file
+containing all the files and sub directories meant to be extracted under the
+.Ev $ROOT
+directory (See 
+.Xr pm 1 ) .
+For example:
+.Bd -literal -width Ds -offset indent
+bin/
+bin/pm
+share/
+share/man/
+share/man/man1/
+share/man/man1/pm.1
+share/man/man5/
+share/man/man5/pack.5
+.Ed
+.Sh USAGE
+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. The typical
+workflow to create packs would be the following:
+.Bd -literal -width Ds -offset indent
+make
+make DESTDIR=/tmp/rootfs install
+cd /tmp/rootfs
+tar -c $(ls) | bzip2 > /tmp/pm#0.0.tar.bz2
+.Ed
+.Pp
+You can check the content of this pack with:
+.Bd -literal -width Ds -offset indent
+bzip2 -cd < /tmp/pm#0.0.tar.bz2 | tar -t
+.Ed
+.Sh SEE ALSO
+.Xr pm 1 ,
+.Xr tar 1 ,
+.Xr bzip2 1 ,
+.Sh AUTHORS
+.An Willy Goiffon Aq Mt willy@mailoo.org