tExplain pack naming convention better - pm - barely a pack manager
HTML git clone git://z3bra.org/pm
DIR Log
DIR Files
DIR Refs
DIR README
DIR LICENSE
---
DIR commit 714472bbfbcc98d91cd52a7ebc7ca205a0601666
DIR parent 7b061f1009b6ce1177e5d5cf694c507009bb5761
HTML Author: z3bra <willyatmailoodotorg>
Date: Wed, 22 Jun 2016 07:14:54 +0200
Explain pack naming convention better
Diffstat:
M pack.5 | 28 +++++++++++++++++++++-------
1 file changed, 21 insertions(+), 7 deletions(-)
---
DIR diff --git a/pack.5 b/pack.5
t@@ -12,18 +12,30 @@ 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
+.Pa <name>#<version>.tar.<ext> .
+.Pp
+The regex used to match pack names is as follows (case sensitive):
+.Bd -literal -offset indent
+([-_a-z0-9]*)#([-.a-zA-Z0-9]*).tar.(gz|bz2|xz)
+.Ed
+.Pp
+name used for packs should remain the original software name, unless it
+doesn't match the regex above. In this case, the name should be changed to
+fit the convention used.
+.Pp
+Libraries pack names MUST be named "lib<name>". For example, the pack for
+"zlib" would be named "libz#<version>.tar.<ext>".
.Ss ARCHIVE FORMAT
-A pack is a
-.Em bzip2
-compressed
+A pack is a compressed
.Em tar file
containing all the files and sub directories meant to be extracted under the
.Ev $ROOT
directory (See
.Xr pm 1 ) .
+Supported compression algorithms are
+.Em gzip , bzip2 , xz .
For example:
-.Bd -literal -width Ds -offset indent
+.Bd -literal -offset indent
bin/
bin/pm
share/
t@@ -39,7 +51,7 @@ In order to create a pack suitable for use with
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
+.Bd -literal -offset indent
make
make DESTDIR=/tmp/rootfs install
cd /tmp/rootfs
t@@ -47,12 +59,14 @@ 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
+.Bd -literal -offset indent
bzip2 -cd < /tmp/pm#0.0.tar.bz2 | tar -t
.Ed
.Sh SEE ALSO
.Xr pm 1 ,
.Xr tar 1 ,
+.Xr gzip 1 ,
.Xr bzip2 1 ,
+.Xr xz 1 ,
.Sh AUTHORS
.An Willy Goiffon Aq Mt willy@mailoo.org