1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
|
Description: Escapes the "-" character in the manpages
By default, "-" chars are interpreted as hyphens (U+2010) by groff, not as
as minus signs (U+002D). Since options to programs use minus signs (U+002D),
this means for example in UTF-8 locales that you cannot cut and paste options,
nor search for them easily.
"-" must be escaped ("\-") to be interpreted as minus.
Also fixes minor typo.
Author: Brandon Griffith <brandon@logyx.net>
Last-Update: Wed Jun 15 07:51:08 HST 2016
@@ -10,9 +10,9 @@
.SH SYNOPSIS
\fBporg\fR [OPTIONS] <packages>
.br
-\fBporg\fR -l [OPTIONS] <package> <command>
+\fBporg\fR \-l [OPTIONS] <package> <command>
.br
-\fBporg\fR -q <files>
+\fBporg\fR \-q <files>
.SH DESCRIPTION
.PP
Porg is a program to aid package management when installing packages from source
@@ -31,95 +31,95 @@
Mandatory arguments to long options are mandatory to short options too.
.SH GENERAL OPTIONS
.TP
-\fB-a, --all\fR
+\fB\-a, \-\-all\fR
Apply to all installed packages (not with \fB-r\fR).
.TP
-\fB-L, --logdir\fR=\fIDIR\fR
+\fB\-L, \-\-logdir\fR=\fIDIR\fR
Base log directory. The logs for the installed packages are saved in this
directory. Default is '@LOGDIR@', unless variable LOGDIR is set
in the configuration file (type 'man porgrc' for more information).
.TP
-\fB-v, --verbose\fR
+\fB\-v, \-\-verbose\fR
Verbose output. \fB-vv\fR prints also debugging messages.
.TP
-\fB-x, --exact-version\fR
+\fB\-x, \-\-exact-version\fR
Disable expansion of package version (not with \fB-l\fR).
.br
By default, porg automatically expands the package names given as arguments,
by adding all the versions of the package that are registered in the porg
database. For instance, if foo-1.0 and foo-2.0 are installed, the
-command 'porg -r foo' would remove both packages, and 'porg -r foo-1'
+command 'porg \-r foo' would remove both packages, and 'porg \-r foo-1'
would remove only foo-1.0.
.br
The option \fB-x\fR inhibits this expansion, so that package names must match
the basename and the whole version of a registered package.
.TP
-\fB-h, --help\fR
+\fB\-h, \-\-help\fR
Display a help message and exit.
.TP
-\fB-V, --version\fR
+\fB\-V, \-\-version\fR
Display version information and exit.
.SH GENERAL LIST OPTIONS
These options can be used to list packages or files.
.TP
-\fB-R, --reverse\fR
+\fB\-R, \-\-reverse\fR
Reverse order while sorting.
.TP
-\fB-t, --total\fR
+\fB\-t, \-\-total\fR
Print totals at the bottom of the list, when appliable.
When printing total sizes, the sizes of hardlinks to installed files are counted
only once.
.TP
-\fB-z, --no-package-name\fR
+\fB\-z, \-\-no-package-name\fR
Do not print the name of the package when listing. Useful for scripts.
.SH PACKAGE LIST OPTIONS
.TP
-\fB-s, --size\fR
+\fB\-s, \-\-size\fR
Print the installed size of the package. Sizes of hardlinks to installed
files are counted only once.
.TP
-\fB-F, --nfiles\fR
+\fB\-F, \-\-nfiles\fR
Print the number of installed files.
.TP
-\fB-d, --date\fR
+\fB\-d, \-\-date\fR
Print the installation date of the package. Double it ('\fB-dd\fR') to print
also the hour.
.TP
-\fB-S, --sort\fR=\fIWORD\fR
+\fB\-S, \-\-sort\fR=\fIWORD\fR
Sort the list by WORD: 'name', 'size', 'files' or 'date'.
.SH FILE LIST OPTIONS
.TP
-\fB-f, --files\fR
+\fB\-f, \-\-files\fR
List the files installed by the package.
.TP
-\fB-s, --size\fR
+\fB\-s, \-\-size\fR
Print the size of each file.
.TP
-\fB-y, --symlinks\fR
+\fB\-y, \-\-symlinks\fR
Print the contents of symbolic links.
.TP
-\fB-S, --sort\fR=\fIWORD\fR
+\fB\-S, \-\-sort\fR=\fIWORD\fR
Sort the list by WORD: 'name' or 'size'.
.SH PACKAGE INFORMATION OPTIONS
Only one of these options may be used at once.
.TP
-\fB-i, --info\fR
+\fB\-i, \-\-info\fR
Print package information (like summary, author, URL...), if available.
.TP
-\fB-o, --configure-options\fR
+\fB\-o, \-\-configure-options\fR
Print the arguments (command line options and environment variables) passed
to the 'configure' script when the package was built.
.TP
-\fB-q, --query\fR
+\fB\-q, \-\-query\fR
Query for the packages that own the files specified as arguments.
.SH PACKAGE LOG OPTIONS
.TP
-\fB-l, --log\fR
+\fB\-l, \-\-log\fR
Enable log mode. If a shell command is given as argument, execute
and monitor it, logging the created files; otherwise the list of files
to be logged is read from the standard input. In either case, the relative
@@ -131,16 +131,16 @@
.br
See \fIEXAMPLES\fR and \fIFILE NAMES WITH SPACES\fR below.
.TP
-\fB-p, --package\fR=\fIPKG\fR
+\fB\-p, \-\-package\fR=\fIPKG\fR
Specify the name of the package to be logged. With \fB-v\fR, the list of logged
files is also printed to the standard error stream. With \fB-vv\fR, porg prints
detailed information about the install process. This holds for option \fB-D\fR
too.
.TP
-\fB-D, --dirname\fR
+\fB\-D, \-\-dirname\fR
Use the name of the current directory as the name of the package to be logged.
.TP
-\fB-E, --exclude\fR=\fIPATH1:PATH2:...\fR
+\fB\-E, \-\-exclude\fR=\fIPATH1:PATH2:...\fR
Colon-separated list of paths to skip when logging the installed files. Default
is '@EXCLUDE@', unless variable \fBexclude\fR is set in the configuration file
(type 'man porgrc' for more information).
@@ -148,7 +148,7 @@
Shell wildcards are allowed in the PATHs. See \fIPATH MATCHING\fR below for
more details.
.TP
-\fB-I, --include\fR=\fIPATH1:PATH2:...\fR
+\fB\-I, \-\-include\fR=\fIPATH1:PATH2:...\fR
Colon-separated list of paths to scan when logging the installed files. Default
is '/', unless variable \fBinclude\fR is set in the configuration file
(type 'man porgrc' for more information).
@@ -156,29 +156,29 @@
Shell wildcards are allowed in the PATHs. See \fIPATH MATCHING\fR below for
more details.
.TP
-\fB-j, --log-missing\fR
+\fB\-j, \-\-log-missing\fR
By default, when installing a package porg registers only those files
that exist in the filesystem right after the installation. With this
option porg registers also the missing files.
.TP
-\fB-+, --append\fR
+\fB\-+, \-\-append\fR
With \fB-p\fR or \fB-D\fR, if the package is already registered, append the list
of created files to its log.
.SH PACKAGE REMOVE OPTIONS
.TP
-\fB-r, --remove\fR
+\fB\-r, \-\-remove\fR
Remove a package, keeping the shared files and asking for confirmation by
default.
.TP
-\fB-U, --unlog\fR
+\fB\-U, \-\-unlog\fR
Unregister the package from the database, without removing any file.
.TP
-\fB-b, --batch\fR
+\fB\-b, \-\-batch\fR
Don't prompt for confirmation when removing or unlogging (and assume yes
to all questions).
.TP
-\fB-e, --skip\fR=\fIPATH1:PATH2:...\fR
+\fB\-e, \-\-skip\fR=\fIPATH1:PATH2:...\fR
Colon-separated list of paths to skip when removing a package. Default is ''
(all logged files are removed), unless variable \fBremove_skip\fR is set in the
configuration file (type 'man porgrc' for more information).
@@ -199,52 +199,52 @@
.SH FILE NAMES WITH SPACES
As of version \fB0.3\fR, porg accepts filenames with spaces when logging
package installations. Although IMHO this should be seen as an improvement in
-general terms, it may cause problems when trying to feed 'porg -l' with a list
+general terms, it may cause problems when trying to feed 'porg \-l' with a list
of files separated by spaces. For example, the following command:
.PP
- echo /bin/foo /bin/bar | porg -l
+ echo /bin/foo /bin/bar | porg \-l
.PP
would try to log the file "/bin/foo /bin/bar" instead of logging /bin/foo and
/bin/bar separately. To fix this, one may use newlines to separate file names,
and pass option \fB-e\fR to echo so it honours escape characters, like this:
.PP
- echo -e "/bin/foo\\n/bin/bar" | porg -l
+ echo \-e "/bin/foo\\n/bin/bar" | porg \-l
.PP
or either write the list of files separated by newlines into a temporary file,
and run:
.PP
- cat tmpfile | porg -l
+ cat tmpfile | porg \-l
.SH EXAMPLES
To log the installation of the package 'foo-1.0', which is installed
-with the command 'make -C src install':
+with the command 'make \-C src install':
.PP
- porg -lp foo-1.0 "make -C src install"
+ porg \-lp foo-1.0 "make \-C src install"
.PP
Note that in this example the quotes are required to prevent
-porg to consider '-C' as a command line option.
-The special end-of-option argument '--' may be used for the same purpose:
+porg to consider '\-C' as a command line option.
+The special end-of-option argument '\-\-' may be used for the same purpose:
.PP
- porg -lp foo-1.0 -- make -C src install
+ porg \-lp foo-1.0 -- make \-C src install
.PP
Use single quotes if the command already contains double quotes:
.PP
- porg -lp foo-1.0 'echo "hello world" > /var/log/foo.log'
+ porg \-lp foo-1.0 'echo "hello world" > /var/log/foo.log'
.PP
Alternatively, we can use the basename of the current directory as the name of
the package to be logged, using the option \fB-D\fR instead of \fB-p\fR:
.PP
- porg -lD "make install && make install.man"
+ porg \-lD "make install && make install.man"
.PP
If we have forgotten to install a file, it can be added to a previously
created log with the option \fB-+\fR:
.PP
- porg -lp+ foo-1.0 "install bar /bin/bar"
+ porg \-lp+ foo-1.0 "install bar /bin/bar"
.PP
Note that the option \fB-+\fR cannot be used to remove a file from the
log. For instance, the following command:
.PP
- porg -lp+ foo-1.0 "rm /bin/bar"
+ porg \-lp+ foo-1.0 "rm /bin/bar"
.PP
would not remove the file /bin/bar from the log of foo-1.0.
.PP
@@ -253,28 +253,28 @@
imagine that a package installs the file /bin/bar, but we want it to
be installed in /usr/bin/bar instead. If one runs this:
.PP
- porg -lp foo-1.0 make install
+ porg \-lp foo-1.0 make install
.br
- porg -lp+ foo-1.0 "mv /bin/bar /usr/bin/bar"
+ porg \-lp+ foo-1.0 "mv /bin/bar /usr/bin/bar"
.PP
Both files, /bin/bar and /usr/bin/bar remain in the log. This is
usually not the desired behaviour. As a workaround one can join up
both commands in one single porg run:
.PP
- porg -lp foo-1.0 "make install && mv /bin/bar /usr/bin/bar"
+ porg \-lp foo-1.0 "make install && mv /bin/bar /usr/bin/bar"
.PP
In this case only /usr/bin/bar is logged.
.PP
To remove the package foo-3.3, keeping the files in /etc and the files
ending with ".conf":
.PP
- porg -r -e '/etc:*.conf' foo-3.3
+ porg \-r \-e '/etc:*.conf' foo-3.3
.PP
You have installed the package 'boo-1.9' in prefix '/opt/boo-1.9', but
you haven't logged the installation with porg. No problem! Just create a log
for it thusly:
.PP
- find /opt/boo-1.9 | porg -lp boo-1.9
+ find /opt/boo-1.9 | porg \-lp boo-1.9
.PP
By the way, porg internally converts all package names to lower case; 'FooBar'
and 'foobar' are the same package.
@@ -8,9 +8,9 @@
.SH NAME
porgball - Binary package support for porg(8).
.SH SYNOPSIS
-\fBporgball\fR [OPTIONS] [-a|<packages>]
+\fBporgball\fR [OPTIONS] [\-a|<packages>]
.br
-\fBporgball\fR -e [OPTIONS] <porgballs>
+\fBporgball\fR \-e [OPTIONS] <porgballs>
.SH DESCRIPTION
.PP
By default, \fBporgball\fR may be given one or more
@@ -27,29 +27,29 @@
system, optionally logging the installation with porg(8).
.PP
\fBNote\fR: Options cannot be joined up, for instance: '\fB-af\fR' is not correct,
-type '\fB-a -f\fR' instead.
+type '\fB\-a \-f\fR' instead.
.PP
Mandatory arguments to long options are mandatory for short options too.
.SH GENERAL OPTIONS
.TP
-\fB-h, --help\fR
+\fB\-h, \-\-help\fR
Show usage information and exit.
.TP
-\fB-v, --verbose\fR
+\fB\-v, \-\-verbose\fR
Explain what is being done.
.TP
-\fB-V, --version\fR
+\fB\-V, \-\-version\fR
Print version information and exit.
.TP
-\fB-L, --logdir\fR=\fIDIR\fR
+\fB\-L, \-\-logdir\fR=\fIDIR\fR
Porg log directory. Default is '@LOGDIR@', unless option LOGDIR is set
in \fBporgrc(5)\fR.
.SH PORGBALL CREATION OPTIONS
.TP
-\fB-a, --all\fR
+\fB\-a, \-\-all\fR
Create a porgball for each package logged in the porg database.
.TP
-\fB-X, --exact-version\fR
+\fB\-X, \-\-exact-version\fR
Disable expansion of package version.
.br
By default, porgball automatically expands the package names given as arguments,
@@ -59,48 +59,48 @@
The option \fB-X\fR inhibits this expansion, so that package names must match
the basename and the whole version of a registered package.
.TP
-\fB-d, --directory\fR=\fIDIR\fR
+\fB\-d, \-\-directory\fR=\fIDIR\fR
Create the porgballs in directory DIR (default is '.').
.TP
-\fB-g, --gzip\fR
+\fB\-g, \-\-gzip\fR
Compress with gzip (default).
.TP
-\fB-b, --bzip2\fR
+\fB\-b, \-\-bzip2\fR
Compress with bzip2.
.TP
-\fB-x, --xz\fR
+\fB\-x, \-\-xz\fR
Compress with xz.
.TP
\fB-#\fR
Set the compression level (speed/quality balance). '#' is a number between 1
(faster compression) and 9 (best compression). Default is 9.
.TP
-\fB--fast\fR
-An alias for -1.
+\fB\-\-fast\fR
+An alias for \-1.
.TP
-\fB--best\fR
-An alias for -9.
+\fB\-\-best\fR
+An alias for \-9.
.TP
-\fB-f, --force\fR
+\fB\-f, \-\-force\fR
Force overwrite of existing output files.
.TP
-\fB-t, --test\fR
+\fB\-t, \-\-test\fR
Test intergity of the porgball after creating it.
.TP
-\fB-n, --no-porg-suffix\fR
+\fB\-n, \-\-no-porg-suffix\fR
Do not append '.porg' suffix to the name of the porgballs.
For instance, create 'foo-1.0.tar.gz' instead of 'foo-1.0.porg.tar.gz'.
.SH PORGBALL EXTRACTION OPTIONS
.TP
-\fB-e, --extract\fR
+\fB\-e, \-\-extract\fR
Extract (install) the given porgballs, in directory '/' by default.
.TP
-\fB-l, --log\fR
-Log the file extraction with porg, retrieving the appropiate
+\fB\-l, \-\-log\fR
+Log the file extraction with porg, retrieving the appropriate
package name from the name of the porgball.
.TP
-\fB-d, --directory\fR=\fIDIR\fR
-Extract the files into directory DIR (as the option -C in tar).
+\fB\-d, \-\-directory\fR=\fIDIR\fR
+Extract the files into directory DIR (as the option \-C in tar).
.SH FILES
.PP
\fI@sysconfdir@/porgrc\fR - porg configuration file
@@ -30,12 +30,12 @@
The following options can be set. The equivalent command line options (if any),
are listed in brackets:
.TP
-\fBlogdir\fR [-L|--logdir]
+\fBlogdir\fR [\-L|\-\-logdir]
.br
Base porg logs directory. Default is '@LOGDIR@'. Environment variables like
$HOME are expanded at runtime.
.TP
-\fBinclude\fR [-I|--include]
+\fBinclude\fR [\-I|\-\-include]
.br
Colon-separated list of paths to scan when logging the installation of a
package. Default is '/'.
@@ -43,7 +43,7 @@
Shell wildcards are allowed in the paths. See \fIPATH MATCHING\fR below for
more details.
.TP
-\fBexclude\fR [-E|--exclude]
+\fBexclude\fR [\-E|\-\-exclude]
.br
Colon-separated list of paths to skip when logging the installation of a
package. Default is '@EXCLUDE@'.
@@ -51,7 +51,7 @@
Shell wildcards are allowed in the paths. See \fIPATH MATCHING\fR below for
more details.
.TP
-\fBremove_skip\fR [-e|--skip]
+\fBremove_skip\fR [\-e|\-\-skip]
.br
Colon-separated list of paths to skip when removing a
package. Default is '' (all logged files are removed).
|