From ab2b9947f4ba029d54428108e7743350e51b7664 Mon Sep 17 00:00:00 2001 From: Thomas Leonard Date: Sat, 9 Jan 2010 14:42:09 +0000 Subject: [PATCH] Escaped minus signs in man-pages Lintian complains about this. --- 0alias.1 | 20 ++++++------- 0desktop.1 | 4 +-- 0launch.1 | 82 ++++++++++++++++++++++++++--------------------------- 0store-secure-add.1 | 14 ++++----- 0store.1 | 14 ++++----- 5 files changed, 67 insertions(+), 67 deletions(-) diff --git a/0alias.1 b/0alias.1 index ed7d812..a7a89ce 100644 --- a/0alias.1 +++ b/0alias.1 @@ -1,6 +1,6 @@ .TH 0ALIAS 1 "2009" "Thomas Leonard" "" .SH NAME -0alias \- create quick scripts to run 0launch +0alias \(em create quick scripts to run 0launch .SH SYNOPSIS @@ -23,17 +23,17 @@ A program can be invoked using 0launch: .PP To avoid having to keep entering the URI, create an alias: -.B 0alias rox-edit http://rox.sourceforge.net/2005/interfaces/Edit +.B 0alias rox\-edit http://rox.sourceforge.net/2005/interfaces/Edit .PP To run Edit now: -.B rox-edit +.B rox\-edit .PP To select a different version, or check for updates: -.B 0alias rox-edit +.B 0alias rox\-edit .PP If an interface provides more than one program, you can specify which @@ -47,30 +47,30 @@ one to use instead of the default. e.g. .SH COMMAND-LINE OPTIONS .TP -\fB-d=DIR\fP, \fB--dir=DIR\fP +\fB\-d=DIR\fP, \fB\-\-dir=DIR\fP Install the script into directory DIR, rather than searching for a suitable directory in $PATH. .TP -\fB-h\fP, \fB--help\fP +\fB\-h\fP, \fB\-\-help\fP Show the built-in help text. .TP -\fB-m\fP, \fB--manpage\fP +\fB\-m\fP, \fB\-\-manpage\fP Display the manpage for the alias script given as the single argument. The alias can be an absolute pathname, or the name of a script in $PATH. If the argument isn't an alias script, or if multiple arguments are given, then all arguments are passed to the system 'man' command. This allows you to alias your man command like this: -alias man='0alias --manpage' +alias man='0alias \-\-manpage' .TP -\fB-r\fP, \fB--resolve\fP +\fB\-r\fP, \fB\-\-resolve\fP Print the interface URI for the given alias script to stdout. .TP -\fB-V\fP, \fB--version\fP +\fB\-V\fP, \fB\-\-version\fP Display version information. .SH LICENSE diff --git a/0desktop.1 b/0desktop.1 index f728bee..3e1fdbf 100644 --- a/0desktop.1 +++ b/0desktop.1 @@ -1,13 +1,13 @@ .TH 0DESKTOP 1 "2009" "Thomas Leonard" "" .SH NAME -0desktop \- add programs to the desktop environment +0desktop \(em add programs to the desktop environment .SH SYNOPSIS .B 0destkop [ \fBURI\fP ] -.B 0destkop --manage +.B 0destkop \-\-manage .SH DESCRIPTION .PP diff --git a/0launch.1 b/0launch.1 index ab8f5e6..890e029 100644 --- a/0launch.1 +++ b/0launch.1 @@ -1,6 +1,6 @@ .TH 0LAUNCH 1 "2009" "Thomas Leonard" "" .SH NAME -0launch \- download and run programs by URL +0launch \(em download and run programs by URL .SH SYNOPSIS @@ -8,10 +8,10 @@ [\fBOPTION\fP]... \fBINTERFACE\fP [\fBARG\fP]... .B 0launch ---list [\fBSEARCH-TERM\fP] +\-\-list [\fBSEARCH\-TERM\fP] .B 0launch ---import [\fBINTERFACE-FILES\fP] +\-\-import [\fBINTERFACE\-FILES\fP] .SH DESCRIPTION .PP @@ -47,12 +47,12 @@ the program will run directly from the cache without confirmation. .PP To check for new versions: -.B 0launch --refresh http://rox.sourceforge.net/2005/interfaces/Edit +.B 0launch \-\-refresh http://rox.sourceforge.net/2005/interfaces/Edit .PP To search the list of cached URLs: -.B 0launch --list Edit +.B 0launch \-\-list Edit .PP To avoid having to keep typing the full URI, use the 0alias(1) command @@ -61,35 +61,35 @@ to create shortcuts to run your programs. .SH COMMAND-LINE OPTIONS .TP -\fB--before=VERSION\fP +\fB\-\-before=VERSION\fP Chosen implementation's version number must be earlier than VERSION. i.e., force the use of an old version the program. .TP -\fB-c\fP, \fB--console\fP +\fB\-c\fP, \fB\-\-console\fP Never use the GUI. Normally, 0launch switches to graphical mode if it needs to download anything from the network (unless DISPLAY is not set). .TP -\fB-d\fP, \fB--download-only\fP +\fB\-d\fP, \fB\-\-download\-only\fP Download any needed files, but stop before actually running the program. .TP -\fB-D\fP, \fB--dry-run\fP +\fB\-D\fP, \fB\-\-dry\-run\fP Just print what actions would be taken. .TP -\fB-f\fP, \fB--feed\fP +\fB\-f\fP, \fB\-\-feed\fP Register (or unregister) an additional source of implementations. When you get a CVS version of a project, it may contain an interface XML file. To add this -version to the list of available versions, use --feed on this XML file. The +version to the list of available versions, use \-\-feed on this XML file. The file is not copied, so you don't need to re-add the file each time it is updated. Note that if you just want to run the program, you can invoke 0launch on the -interface file directly (without using --feed). This will force the injector to +interface file directly (without using \-\-feed). This will force the injector to use that version, but won't affect what happens when you run it using the URI -as normal. Use --feed when you want to use the CVS version even when using the +as normal. Use \-\-feed when you want to use the CVS version even when using the URI, or if the program is a library (and thus referenced by URI by other programs). @@ -98,80 +98,80 @@ which case you must set this as the preferred stability for the interface (using the GUI). .TP -\fB--get-selections\fP +\fB\-\-get\-selections\fP Instead of running the program, just print the set of chosen implementations as -an XML document to stdout. This can be used later with \fB--set-selections\fP. +an XML document to stdout. This can be used later with \fB\-\-set\-selections\fP. .TP -\fB-g\fP, \fB--gui\fP +\fB\-g\fP, \fB\-\-gui\fP Show the graphical policy editor. This allows you to select which version of a program or library to use. .TP -\fB-h\fP, \fB--help\fP +\fB\-h\fP, \fB\-\-help\fP Show the built-in help text. .TP -\fB-i\fP, \fB--import\fP +\fB\-i\fP, \fB\-\-import\fP Import from files, not from the network. This is useful when testing an interface file, to avoid uploading it to a remote server in order to download it again. It might also be useful when installing from a CD or similar. The file must have a trusted GPG digital signature, as when fetching from -the network. For unsigned interfaces, see --feed. +the network. For unsigned interfaces, see \-\-feed. .TP -\fB-l\fP, \fB--list\fP +\fB\-l\fP, \fB\-\-list\fP List all known interface (program) URIs. If a search term is given, only URIs containing that string are shown (case insensitive). .TP -\fB-m\fP, \fB--main=MAIN\fP +\fB\-m\fP, \fB\-\-main=MAIN\fP Run the specified executable instead of the default. If MAIN starts with '/' then the path is relative to the implementation's top-level directory, whereas otherwise it is relative to the directory containing the default MAIN program. For example, if the default MAIN is \fBbin/svn\fP then -using \fB--main=svnadmin\fP will run \fB.../bin/svnadmin\fP instead. +using \fB\-\-main=svnadmin\fP will run \fB.../bin/svnadmin\fP instead. .TP -\fB--not-before=VERSION\fP +\fB\-\-not\-before=VERSION\fP Chosen implementation's version number must not be earlier than VERSION. -E.g., if you want to run version 2.0 or later, use \fB--not-before=2.0\fP. +E.g., if you want to run version 2.0 or later, use \fB\-\-not\-before=2.0\fP. .TP -\fB-o\fP, \fB--offline\fP +\fB\-o\fP, \fB\-\-offline\fP Run in off-line mode, overriding the default setting. In off-line mode, no interfaces are refreshed even if they are out-of-date, and newer versions of programs won't be downloaded even if the injector already knows about them (e.g. from a previous refresh). .TP -\fB-r\fP, \fB--refresh\fP +\fB\-r\fP, \fB\-\-refresh\fP Fetch a fresh copy of all used interfaces. This will normally switch to GUI -mode, unless --console is also given. Note that using --refresh and --gui +mode, unless \-\-console is also given. Note that using \-\-refresh and \-\-gui together will check for updates to the GUI itself. .TP -\fB--set-selections=FILE\fP +\fB\-\-set\-selections=FILE\fP Instead of choosing suitable implementations using the policy, run exactly the versions given in FILE. A suitable file can be created using the -\fB--get-selections\fP option described above. +\fB\-\-get\-selections\fP option described above. .TP -\fB-s\fP, \fB--source\fP +\fB\-s\fP, \fB\-\-source\fP The implementation of the main (root) interface must have an architecture -of the form '*-src' (normally a literal "*", but could be a compatible OS). +of the form '*\-src' (normally a literal "*", but could be a compatible OS). Dependencies are normal implementations, not source ones. .TP -\fB-v\fP, \fB--verbose\fP +\fB\-v\fP, \fB\-\-verbose\fP More verbose output. Use twice for even more verbose output. .TP -\fB-V\fP, \fB--version\fP +\fB\-V\fP, \fB\-\-version\fP Display version information. .TP -\fB-w\fP, \fB--wrapper=COMMAND\fP +\fB\-w\fP, \fB\-\-wrapper=COMMAND\fP Instead of executing the chosen program directly, run \fBCOMMAND PROGRAM ARGS\fP. This is useful for running debuggers and tracing tools on the program (rather than on 0launch!). Note that the wrapper is executed in the environment selected @@ -179,26 +179,26 @@ by the program; hence, this mechanism cannot be used for sandboxing. See the DEBUGGING section below. .TP -\fB--with-store=DIR\fP +\fB\-\-with\-store=DIR\fP Append a directory to the list of implementation caches. .SH DEBUGGING TIPS .PP -To debug 0launch itself, use the --verbose and --console options. For example: +To debug 0launch itself, use the \-\-verbose and \-\-console options. For example: -.B $ 0launch -vvc http://myprog +.B $ 0launch \-vvc http://myprog .PP -To trace or debug programs run by 0launch, use the --wrapper option. -For example, to run \fBmyprog --help\fP, displaying all calls to open(2): +To trace or debug programs run by 0launch, use the \-\-wrapper option. +For example, to run \fBmyprog \-\-help\fP, displaying all calls to open(2): -.B $ 0launch --wrapper="strace -e open" http://myprog --help +.B $ 0launch \-\-wrapper="strace \-e open" http://myprog \-\-help If your program is interpreted (e.g. a Python program), and you wish to debug the interpreter running it, you can do it like this: -.B $ 0launch --wrapper="gdb --args python" http://myprog --help +.B $ 0launch \-\-wrapper="gdb \-\-args python" http://myprog \-\-help .SH FILES diff --git a/0store-secure-add.1 b/0store-secure-add.1 index f4681a8..2c8a58c 100644 --- a/0store-secure-add.1 +++ b/0store-secure-add.1 @@ -1,10 +1,10 @@ -.TH 0STORE-SECURE-ADD 1 "2009" "Thomas Leonard" "" +.TH 0STORE\-SECURE\-ADD 1 "2009" "Thomas Leonard" "" .SH NAME -0store-secure-add \- add an implementation to the system cache +0store\-secure\-add \(em add an implementation to the system cache .SH SYNOPSIS -.B 0store-secure-add +.B 0store\-secure\-add \fBDIGEST\fP .SH DESCRIPTION @@ -30,7 +30,7 @@ To enable sharing, the system administrator should follow these steps: .PP Create a new system user to own the cache: -.B adduser --system zeroinst +.B adduser \-\-system zeroinst .PP Create the shared directory, owned by this new user: @@ -44,18 +44,18 @@ Use visudo(8) to add these lines to /etc/sudoers: .B Defaults>zeroinst env_reset -.B ALL ALL=(zeroinst) NOPASSWD: /usr/bin/0store-secure-add +.B ALL ALL=(zeroinst) NOPASSWD: /usr/bin/0store\-secure\-add .P Create a script called -.B 0store-secure-add-helper +.B 0store\-secure\-add\-helper in PATH to call it. This script must be executable and contain these two lines: .B #!/bin/sh .B -exec sudo -S -u zeroinst /usr/bin/0store-secure-add "$@" < /dev/null +exec sudo \-S \-u zeroinst /usr/bin/0store\-secure\-add "$@" < /dev/null .P The other Zero Install programs will call this helper script automatically. diff --git a/0store.1 b/0store.1 index a9a798d..d60b401 100644 --- a/0store.1 +++ b/0store.1 @@ -1,6 +1,6 @@ .TH 0STORE 1 "2009" "Thomas Leonard" "" .SH NAME -0store \- manage the implementation cache +0store \(em manage the implementation cache .SH SYNOPSIS @@ -90,7 +90,7 @@ See the list of implementation caches currently configured: .B 0store list -To add directories to this list, add them to your 'implementation-dirs' +To add directories to this list, add them to your 'implementation\-dirs' configuration file. .SH MANIFEST @@ -142,15 +142,15 @@ tree, it displays a list of the differences (in unified diff format). .SH COMMAND-LINE OPTIONS .TP -\fB-h\fP, \fB--help\fP +\fB\-h\fP, \fB\-\-help\fP Show the built-in help text. .TP -\fB-v\fP, \fB--verbose\fP +\fB\-v\fP, \fB\-\-verbose\fP More verbose output. Use twice for even more verbose output. .TP -\fB-V\fP, \fB--version\fP +\fB\-V\fP, \fB\-\-version\fP Display version information. .SH FILES @@ -158,7 +158,7 @@ Display version information. .IP "~/.cache/0install.net/implementations" Cached implementations, indexed by manifest digest. -.IP "~/.config/0install.net/injector/implementation-dirs" +.IP "~/.config/0install.net/injector/implementation\-dirs" List of system cache directories, one per line. .SH LICENSE @@ -179,7 +179,7 @@ http://0install.net/support.html The Zero Install Injector was created by Thomas Leonard. .SH SEE ALSO -0alias(1), 0launch(1), 0store-secure-add(1) +0alias(1), 0launch(1), 0store\-secure\-add(1) .PP The Zero Install web-site: -- 2.11.4.GIT