]> pd.if.org Git - zpackage/blob - doc/zpm-add.8
ocb mode fixup
[zpackage] / doc / zpm-add.8
1 .TH zpm-add 8 2019-02-15 "ZPM 0.4"
2 .SH NAME
3 zpm-add \- add files to a package
4 .SH SYNOPSIS
5 .B zpm add
6 .RI -f packagefile
7 .B [ -icCNschlrvxz ]
8 .BI "[ -F " type " ]"
9 .BI "[ -H " hash " ]"
10 .BI "[ -M " mtime " ]"
11 .BI "[ -P " prefix " ]"
12 .BI "[ -S " stripprefix " ]"
13 .BI "[ -s " n " ]"
14 .BI "[ -T " target " ]"
15 .BI "[ -f " path " ]"
16 .BI "[ -g " group " ]"
17 .BI "[ -u " user " ]"
18 .BI "[ -m " mode " ]"
19 .BI "[ -p " package " ]"
20 .IR path ...
21 .SH DESCRIPTION
22 \fBzpm-add\fR adds files to a zpm package.
23 The package file must exist, and the package in the package file
24 must exist.  File metadata is taken from the filesystem, unless
25 overridden by command line options.
26 .PP
27 If the package name is not given with the \-p option, it will be inferred.
28 from the package file name.  The package file name must be parsable as a
29 complete package id.
30 .SH OPTIONS
31 .TP
32 .B \-i
33 Create the package if necessary, create the package file if it does not
34 exist.
35 .TP
36 .B \-C
37 mark the package as complete when finished.  Normally a package
38 is marked as incomplete after adding files.
39 .TP
40 .B \-c
41 Mark added files as config files.
42 .TP
43 .BI \-p pkgid
44 Add files to the named package.  The package will be looked up as if by
45 zpm-findpkg.  Overrides \-i.
46 .TP
47 .BI \-F type
48 force added files to be the type.  See Non-Existent Files.
49 .TP
50 .BI \-H hash_value
51 specify the hash value of a file.  See Non-Existent Files.
52 .TP
53 .BI \-M mtime
54 specify mtime.  for a non-existent file, if not specified here, the current
55 time will be used.
56 .TP
57 .BI \-m mode
58 Directly set the mode of added files.  If not set, the mode will be taken
59 from the filesystem.
60 .TP
61 .B \-N
62 Don't add any file content for regular files.
63 .TP
64 .BI \-P prefix
65 Prefix added file paths with the given prefix.  No '/' is added,
66 so the prefix should include a trailing '/' if the prefix is intended
67 to be a directory.
68 .TP
69 .B \-r
70 recursively add paths underneath directories
71 .SH EXAMPLES
72 .TP
73 zpm-add -f passwd-1.0-1.zpm passwd-1.0-1 /etc/passwd
74 Add the /etc/passwd file to the passwd-1.0-1 package.
75 .SH EXIT STATUS
76 0 if adding files was successful
77 1 if adding files failed if -x is not given
78 255 if adding files failed and -x is given
79 .SH FILES
80 None
81 .SH ENVIRONMENT
82 None
83 .SH AUTHOR
84 Nathan Wagner
85 .SH SEE ALSO
86 .BR zpm (8)
87 .BR zpm-packagehash (8)
88 .BR zpm-addfile (8)