]> pd.if.org Git - zpackage/blob - README
add examples to readme
[zpackage] / README
1 ZPM - the ultimate package manager
2 ==================================
3
4 Features
5 --------
6
7 binary installs
8
9 package metadata
10
11 package integrity
12         gpg signatures
13         sha256 sums
14         sha3 sums
15
16 package contents integrity
17         sha256 sums of installed files
18         sha3 sums
19         sha1 sums
20         lists of directory contents
21
22 package database editing
23         mark a file as a configuration file
24
25 repackaging
26         creating a package from the current state of an installed package
27
28 package a tarball
29         create a package from a tarball
30
31 package from stdin
32         like cpio
33
34 package a directory
35         like tar
36
37 build from shell scripts
38
39 rebuild a package
40
41 write ahead log for package filesystem operations
42         it should always be possible for the package system
43         to figure out if it was interrupted
44
45 install, uninstall, upgrade, and downgrade hooks
46
47 dependency tracking
48
49 network fetching of packages and package databases
50 reference counting of dynamic libs
51
52 simple packaging constructs
53         use shell scripts where possible
54         use shell functions as hooks and callbacks
55
56 A package is an SQLite database file.
57
58 Multiple packages in the same file.
59
60 need to mark a package as held for no automatic upgrade
61
62 configure to run a command after any package work
63
64 System Administration
65 ---------------------
66
67 Install a package
68
69         zpm install <pkgname>
70
71 Add a repository
72
73         zpm repo add <repo_url>
74
75 List the files owned by a package
76
77         zpm contents <pkgname>
78
79 Capture current state of configuration files
80
81         zpm capture <pkgname>
82
83 Create a package file from an installed package
84
85         zpm export <pkgname>
86
87 Extract file content from a package
88
89         zpm extract <hash> <path>
90
91 Packaging Software
92 ------------------
93
94 Build a package in the current directory
95
96         zpm build
97
98 Create a package from a tarball
99
100         zpm build -t <tarfile> <packagefile>
101
102 Import the contents of one package file into another
103
104         zpm merge <basefile> <otherfile>
105
106 Create a package from a list of file names on stdin
107
108         find <find_options> | zpm build -s <packagefile>
109
110 Create a new empty package
111
112         zpm newpackage <packagefile>
113
114 Add a file to a package in a package db
115
116         zpm addtopackage <packagefile> <filepath>
117
118 Mark a file as a configuration file
119
120         zpm mark -c <packagefile> <path>
121
122 Mark a package as finished building
123
124         zpm complete <packagefile> <packagename>
125
126 Utilities
127 ---------
128
129 Show the elf libraries needed by a program or library
130
131         zpm soneed <file>
132
133 Show the elf library provided by a library file
134
135         zpm soname <file>
136
137 Get the sha256 hash of a file
138
139         zpm hash <file>
140
141 Get the unix timestamp of a file
142
143         zpm stat -f '%m' <file>
144
145 Get the uid of a file
146
147         zpm stat -f '%u' <file>