qi: Bump to version 2.4 (Release Candidate 5)
[dragora.git] / qi / doc / qi.1
blobfa3344568d53c184627829b24b4e06d97e04fa75
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.2.
2 .TH QI "1" "March 2021" "qi 2.4-rc5" "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 .SH OPTIONS
17 .SS "List of commands:"
18 .TP
19 warn
20 Warn about files that will be installed
21 .TP
22 install
23 Install packages
24 .TP
25 remove
26 Remove packages
27 .TP
28 upgrade
29 Upgrade packages
30 .TP
31 extract
32 Extract packages for debugging purposes
33 .TP
34 create
35 Create a .tlz package from directory
36 .TP
37 build
38 Build packages using recipe names
39 .TP
40 order
41 Resolve build order through .order files
42 .SS "Options when installing, removing, or upgrading software packages:"
43 .TP
44 \fB\-f\fR, \fB\-\-force\fR
45 Force upgrade of pre\-existing packages
46 .TP
47 \fB\-k\fR, \fB\-\-keep\fR
48 Keep package directory when remove/upgrade
49 .TP
50 \fB\-p\fR, \fB\-\-prune\fR
51 Prune conflicts
52 .TP
53 \fB\-P\fR, \fB\-\-packagedir=\fR<dir>
54 Set directory for package installations
55 .TP
56 \fB\-t\fR, \fB\-\-targetdir=\fR<dir>
57 Set target directory for symbolic links
58 .TP
59 \fB\-r\fR, \fB\-\-rootdir=\fR<dir>
60 Use the fully qualified named directory as
61 the root directory for all qi operations
62 Note: the target directory and the package
63 directory will be relative to the specified
64 directory, excepting the graft log file
65 .SS "Options when building software packages using recipes:"
66 .TP
67 \fB\-a\fR, \fB\-\-architecture\fR
68 Set architecture name for the package
69 .TP
70 \fB\-j\fR, \fB\-\-jobs\fR
71 Parallel jobs for the compiler
72 .TP
73 \fB\-k\fR, \fB\-\-keep\fR
74 Keep ${srcdir} or ${destdir} when build
75 .TP
76 \fB\-S\fR, \fB\-\-skip\-questions\fR
77 Skip questions on completed recipes
78 .TP
79 \fB\-1\fR, \fB\-\-increment\fR
80 Increment release number (${release} + 1)
81 .TP
82 \fB\-n\fR, \fB\-\-no\-package\fR
83 Do not create a .tlz package
84 .TP
85 \fB\-i\fR, \fB\-\-install\fR
86 Install package after the build
87 .TP
88 \fB\-u\fR, \fB\-\-upgrade\fR
89 Upgrade package after the build
90 .TP
91 \fB\-o\fR, \fB\-\-outdir=\fR<dir>
92 Where the packages produced will be written
93 .TP
94 \fB\-w\fR, \fB\-\-worktree=\fR<dir>
95 Where archives, patches, recipes are expected
96 .TP
97 \fB\-s\fR, \fB\-\-sourcedir=\fR<dir>
98 Where compressed sources will be found
99 .SS "Other options:"
101 \fB\-N\fR, \fB\-\-no\-rc\fR
102 Do not read the configuration file
104 \fB\-v\fR, \fB\-\-verbose\fR
105 Be verbose (an extra \fB\-v\fR gives more)
107 \fB\-L\fR, \fB\-\-show\-location\fR
108 Print default directory locations and exit
110 \fB\-h\fR, \fB\-\-help\fR
111 Display this help and exit
113 \fB\-V\fR, \fB\-\-version\fR
114 Output version information and exit
115 .SH ENVIRONMENT
116 .SS "Some influential environment variables:"
118 TMPDIR
119 Temporary directory for sources
121 QICFLAGS
122 C compiler flags (to be used on CFLAGS)
124 QICXXFLAGS
125 C++ compiler flags (to be used on CXXFLAGS)
127 QILDFLAGS
128 Flags for the linker (to be used on LDFLAGS)
130 QICPPFLAGS
131 C/C++ preprocessor flags (to be used on CPPFLAGS)
133 SOURCE_DATE_EPOCH
134 Last modification time for created packages
135 .SH "SEE ALSO"
136 The full documentation for
137 .B qi
138 is maintained as a Texinfo manual.  If the
139 .B info
141 .B qi
142 programs are properly installed at your site, the command
144 .B info qi
146 should give you access to the complete manual.