pm

barely a pack manager
git clone git://z3bra.org/pm
Log | Files | Refs | README | LICENSE

pack.5 (1891B)


      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 USAGE
     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. Files having
     53 a newline character ('\n') in their name are not supported by
     54 .Xr pm 1 .
     55 The typical workflow to create packs would be the following:
     56 .Bd -literal -offset indent
     57 make
     58 make DESTDIR=/tmp/rootfs install
     59 cd /tmp/rootfs
     60 tar -c $(ls) | bzip2 > /tmp/pm@0.0.tbz
     61 .Ed
     62 .Pp
     63 You can check the content of this pack with:
     64 .Bd -literal -offset indent
     65 bzip2 -cd < /tmp/pm@0.0.tbz | tar -t
     66 .Ed
     67 .Sh SEE ALSO
     68 .Xr pm 1 ,
     69 .Xr tar 1 ,
     70 .Xr gzip 1 ,
     71 .Xr bzip2 1 ,
     72 .Xr xz 1 ,
     73 .Sh AUTHORS
     74 .An Willy Goiffon Aq Mt willy@mailoo.org