epydoc fixes
[zeroinstall/zeroinstall-limyreth.git] / 0alias.1
blob0a005d1070faad98142fe6d72cc385c6991c2c5b
1 .TH 0ALIAS 1 "2010" "Thomas Leonard" ""
2 .SH NAME
3 0alias \(em create quick scripts to run 0launch
5 .SH SYNOPSIS
7 .B 0alias
8 \fBALIAS\fP [\fBINTERFACE\fP [\fBCOMMAND\fP]]
10 .SH DESCRIPTION
11 .PP
12 Having to keep typing the full URI for a program each time you want to run it
13 with 0launch is annoying. 0alias will create a little script in your PATH to
14 do it for you.
16 .SH EXAMPLES
18 .PP
19 A program can be invoked using 0launch:
21 .B 0launch http://rox.sourceforge.net/2005/interfaces/Edit
23 .PP
24 To avoid having to keep entering the URI, create an alias:
26 .B 0alias rox\-edit http://rox.sourceforge.net/2005/interfaces/Edit
28 .PP
29 To run Edit now:
31 .B rox\-edit
33 .PP
34 To select a different version, or check for updates:
36 .B 0alias rox\-edit
38 .PP
39 If an interface provides more than one program, you can specify which
40 one to use instead of the default. e.g.
42 .B 0alias svn http://example.com/subversion
44 .B 0alias svnadmin http://example.com/subversion svnadmin
47 .SH COMMAND-LINE OPTIONS
49 .TP
50 \fB\-d=DIR\fP, \fB\-\-dir=DIR\fP
51 Install the script into directory DIR, rather than searching for a suitable
52 directory in $PATH.
54 .TP
55 \fB\-h\fP, \fB\-\-help\fP
56 Show the built-in help text.
58 .TP
59 \fB\-m\fP, \fB\-\-manpage\fP
60 Display the manpage for the alias script given as the single argument. The
61 alias can be an absolute pathname, or the name of a script in $PATH. If the
62 argument isn't an alias script, or if multiple arguments are given, then all
63 arguments are passed to the system 'man' command. This allows you to alias your
64 man command like this:
66 alias man='0alias \-\-manpage'
68 .TP
69 \fB\-r\fP, \fB\-\-resolve\fP
70 Print the interface URI for the given alias script to stdout.
72 .TP
73 \fB\-V\fP, \fB\-\-version\fP
74 Display version information.
76 .SH LICENSE
77 .PP
78 Copyright (C) 2007 Thomas Leonard.
80 .PP
81 You may redistribute copies of this program under the terms of the GNU Lesser General Public License.
82 .SH BUGS
83 .PP
84 Please report bugs to the developer mailing list:
86 http://0install.net/support.html
88 .SH AUTHOR
89 .PP
90 The Zero Install Injector was created by Thomas Leonard.
92 .SH SEE ALSO
93 0launch(1), 0desktop(1)
94 .PP
95 The Zero Install web-site:
97 .B http://0install.net