tpack.5 - pm - barely a pack manager
 (HTM) git clone git://z3bra.org/pm
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) README
 (DIR) LICENSE
       ---
       tpack.5 (1713B)
       ---
            1 .Dd 2016-01-13
            2 .Dt PACK 5
            3 .Os POSIX.1-2008
            4 .Sh NAME
            5 .Nm pack
            6 .Nd pack file format
            7 .Sh DESCRIPTION
            8 .Nm
            9 is the name given to compressed archives used by
           10 .Xr pm 1
           11 to install softwares under a directory.
           12 .Ss FILENAME
           13 The pack name is used to extract informations about it content, and should
           14 follow a strict naming scheme:
           15 .Pa <name>@<version>.<ext> .
           16 .Pp
           17 The regex used to match pack names is as follows (case sensitive):
           18 .Bd -literal -offset indent
           19 ([-_a-z0-9]*)@([-.a-zA-Z0-9]*).t(bz|gz|xz)
           20 .Ed
           21 .Pp
           22 name used for packs should remain the original software name, unless it
           23 doesn't match the regex above. In this case, the name should be changed to
           24 fit the convention used.
           25 .Pp
           26 Libraries pack names MUST be named "lib<name>". For example, the pack for
           27 "zlib" would be named "libz@<version>.<ext>".
           28 .Ss ARCHIVE FORMAT
           29 A pack is a compressed
           30 .Em tar file
           31 containing all the files and sub directories meant to be extracted under the
           32 .Ev $ROOT
           33 directory (See 
           34 .Xr pm 1 ) .
           35 Supported compression algorithms are
           36 .Em gzip , bzip2 , xz .
           37 For example:
           38 .Bd -literal -offset indent
           39 bin/
           40 bin/pm
           41 share/
           42 share/man/
           43 share/man/man1/
           44 share/man/man1/pm.1
           45 share/man/man5/
           46 share/man/man5/pack.5
           47 .Ed
           48 .Sh EXAMPLE
           49 In order to create a pack suitable for use with
           50 .Xr pm 1 ,
           51 you can use external tools to first install your pack into a specific
           52 directory, change to this directory and archive its content.
           53 .Bd -literal
           54   make
           55   make DESTDIR=$PWD/tmproot PREFIX= install
           56   tar -C ./tmproot -f /tmp/pm@1.3.tbz -cj .
           57 .Ed
           58 .Pp
           59 You can then check the content of this pack with:
           60 .Bd -literal
           61   tar -f /tmp/pm@1.3.tbz -tj
           62 .Ed
           63 .Sh SEE ALSO
           64 .Xr pm 1 ,
           65 .Xr tar 1 ,
           66 .Xr gzip 1 ,
           67 .Xr bzip2 1 ,
           68 .Xr xz 1 ,
           69 .Sh AUTHORS
           70 .An Willy Goiffon Aq Mt dev@z3bra.org