summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorBenjamin Drung <bdrung@ubuntu.com>2010-01-06 23:43:36 +0100
committerBenjamin Drung <bdrung@ubuntu.com>2010-01-06 23:43:36 +0100
commit94b031ec30038c9ede5a9cf1416f754fa510b85a (patch)
tree11e857d70d852f119f8e839828e26649ac93df98 /man
parent51b7537b3ddfb6ca806f961ac20480a69db8bca8 (diff)
- wrote man page for install-xpi
- add man/install-xpi.1 - update src/Makefile
Diffstat (limited to 'man')
-rw-r--r--man/install-xpi.166
1 files changed, 66 insertions, 0 deletions
diff --git a/man/install-xpi.1 b/man/install-xpi.1
new file mode 100644
index 0000000..1db95d1
--- /dev/null
+++ b/man/install-xpi.1
@@ -0,0 +1,66 @@
+.\"Copyright (c) 2010 Benjamin Drung <bdrung@ubuntu.com>
+.\"
+.\"Permission is hereby granted, free of charge, to any person obtaining a copy
+.\"of this software and associated documentation files (the "Software"), to deal
+.\"in the Software without restriction, including without limitation the rights
+.\"to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+.\"copies of the Software, and to permit persons to whom the Software is
+.\"furnished to do so, subject to the following conditions:
+.\"
+.\"The above copyright notice and this permission notice shall be included in
+.\"all copies or substantial portions of the Software.
+.\"
+.\"THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+.\"IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+.\"FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+.\"AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+.\"LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+.\"OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+.\"THE SOFTWARE.
+.TH INSTALL-XPI "1" "January 2010" "install-xpi" "mozilla-devscripts suite"
+.SH NAME
+install-xpi \- installs a xpi file into a Debian package
+.SH SYNOPSIS
+.B install-xpi
+[\fIoptions\fP]
+\fIxpi-file\fR
+.SH DESCRIPTION
+.B install-xpi
+is a helper tool for packaging XUL extensions. It installs the given xpi file
+into the correct directory and creates the required links based on the data
+in the install.rdf file.
+.B install-xpi
+will correct the file permissions unless \fR\-\-preserve\-permissions\fP is
+specified.
+.SH OPTIONS
+.TP
+\fB\-x\fR \fIfile\fP, \fB\-\-exclude\fR=\fIfile\fP
+The specified \fIfile\fP from the xpi file will not be installed. You can use
+this parameter several times.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Display a brief help message.
+.TP
+\fB\-l\fR \fIdirectory\fP, \fB\-\-link\fR=\fIdirectory\fP
+An additional link from the \fIdirectory\fP to the installation directory of
+the extension will be created. You can use this parameter several times.
+.TP
+\fB\-p\fR \fIpackage\fP, \fB\-\-package\fR=\fIpackage\fP
+The xpi file will be installed in the specified binary package. If this
+parameter is not provided, the first binary package listed in debian/control
+will be used.
+.TP
+.B \-\-preserve\-permissions
+The permissions of the files in the xpi file will not be modified. If this
+parameter is not provided,
+.B install-xpi
+will try to correct the permissions of the files to 644 (files that starts with
+a shebang will be corrected to 755).
+.TP
+\fB\-r\fR, \fB\-\-remove-license-files\fR
+Files with names like copying, licence, or license will not be installed.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Print more information.
+.SH AUTHOR
+Benjamin Drung <bdrung@gmail.com>