qi: Bump to version 2.0 (Release Candidate 12)
[dragora.git] / qi / doc / qi.1
blob10c7e2795b1d815c63973839532b336177f70566
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.16.
2 .TH QI "1" "July 2020" "qi 2.0rc12" "User Commands"
3 .SH NAME
4 qi \- a simple but well-integrated package manager
5 .SH SYNOPSIS
6 .B qi
7 \fI\,COMMAND \/\fR[\fI\,OPTIONS\/\fR] [\fI\,FILE\/\fR]...
8 .SH DESCRIPTION
9 Qi is a simple but well\-integrated package manager.  It can create,
10 install, remove, and upgrade software packages.  Qi produces binary
11 packages using recipes, which are files containing specific instructions
12 to build each package from source.  Qi can manage multiple packages
13 under a single directory hierarchy.  This method allows to maintain a
14 set of packages and multiple versions of them.  This means that Qi could
15 be used as the main package manager or complement the existing one.
16 .PP
17 Defaults for the options are specified in brackets.
18 .SS "List of commands:"
19 .TP
20 warn
21 Warn about files that will be installed
22 .TP
23 install
24 Install packages
25 .TP
26 remove
27 Remove packages
28 .TP
29 upgrade
30 Upgrade packages
31 .TP
32 extract
33 Extract packages for debugging purposes
34 .TP
35 create
36 Create a .tlz package from directory
37 .TP
38 build
39 Build packages using recipe names
40 .TP
41 order
42 Resolve build order through .order files
43 .SS "Options when installing, removing, or upgrading software packages:"
44 .TP
45 \fB\-f\fR, \fB\-\-force\fR
46 Force upgrade of pre\-existing packages
47 .TP
48 \fB\-k\fR, \fB\-\-keep\fR
49 Keep package directory when remove/upgrade
50 .TP
51 \fB\-p\fR, \fB\-\-prune\fR
52 Prune conflicts
53 .TP
54 \fB\-P\fR, \fB\-\-packagedir=\fR<dir>
55 Set directory for package installations
56 .TP
57 \fB\-t\fR, \fB\-\-targetdir=\fR<dir>
58 Set target directory for symbolic links
59 .TP
60 \fB\-r\fR, \fB\-\-rootdir=\fR<dir>
61 Use the fully qualified named directory as
62 the root directory for all qi operations
63 Note: the target directory and the package
64 directory will be relative to the specified
65 directory, excepting the graft log file
66 .SS "Options when building software packages using recipes:"
67 .TP
68 \fB\-a\fR, \fB\-\-architecture\fR
69 Set architecture name for the package [x86_64]
70 .TP
71 \fB\-j\fR, \fB\-\-jobs\fR
72 Parallel jobs for the compiler [1]
73 .TP
74 \fB\-k\fR, \fB\-\-keep\fR
75 Keep `${srcdir}' or `${destdir}' when build
76 .TP
77 \fB\-S\fR, \fB\-\-skip\-questions\fR
78 Skip questions on completed recipes
79 .TP
80 \fB\-1\fR, \fB\-\-increment\fR
81 Increment release number (`${release}' + 1)
82 .TP
83 \fB\-n\fR, \fB\-\-no\-package\fR
84 Do not create a .tlz package
85 .TP
86 \fB\-i\fR, \fB\-\-install\fR
87 Install package after the build
88 .TP
89 \fB\-u\fR, \fB\-\-upgrade\fR
90 Upgrade package after the build
91 .TP
92 \fB\-o\fR, \fB\-\-outdir=\fR<dir>
93 Where the packages produced will be written [/var/cache/qi/packages]
94 .TP
95 \fB\-w\fR, \fB\-\-worktree=\fR<dir>
96 Where archives, patches, recipes are expected [/usr/src/qi]
97 .TP
98 \fB\-s\fR, \fB\-\-sourcedir=\fR<dir>
99 Where compressed sources will be found [/usr/src/qi/sources]
100 .SS "Other options:"
102 \fB\-N\fR, \fB\-\-no\-rc\fR
103 Do not read the configuration file
105 \fB\-v\fR, \fB\-\-verbose\fR
106 Be verbose (an extra \fB\-v\fR gives more) [0]
108 \fB\-L\fR, \fB\-\-show\-location\fR
109 Print default directory locations and exit
111 \fB\-h\fR, \fB\-\-help\fR
112 Display this help and exit
114 \fB\-V\fR, \fB\-\-version\fR
115 Output version information and exit
116 .SS "Some influential environment variables:"
118 TMPDIR
119 Temporary directory for sources [/usr/src/qi/build]
121 QICFLAGS
122 C compiler flags [\-g0 \fB\-Os]\fR
124 QICXXFLAGS
125 C++ compiler flags [\-g0 \fB\-Os]\fR
127 QILDFLAGS
128 Linker flags [\-s]
130 When FILE is \-, read standard input.
132 Exit status: 0 for a normal exit, 1 for minor common errors (help usage,
133 support not available, etc), 2 to indicate a command execution error;
134 3 for integrity check error on compressed files, 4 for empty, not
135 regular, or expected files, 5 for empty or not defined variables,
136 6 when a package already exist, 10 for network manager errors.
138 Qi home page: https://www.dragora.org
139 .SH "SEE ALSO"
140 The full documentation for
141 .B qi
142 is maintained as a Texinfo manual.  If the
143 .B info
145 .B qi
146 programs are properly installed at your site, the command
148 .B info qi
150 should give you access to the complete manual.