summaryrefslogtreecommitdiff
path: root/man/install-xpi.1
blob: 11634a1b00e72e8cea4741b01dfa489860a31706 (plain)
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
.\"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.
It corrects the file permissions unless \fR\-\-preserve\-permissions\fP is
specified.

.B install-xpi
will create a configuration file in /etc if the XUL extension provides one or
more preferences files in defaults/preferences. The configuration file
contains only a description where to find the overridable preferences.
debian/package.js is used as configuration file instead if it
exists. The placeholder @INSTALLDIR@ is replaces by the actual installation
directory. You can disable the creation of a system configuration file with
\-\-disable\-system\-prefs.
.SH OPTIONS
.TP
.B \-\-disable\-system\-prefs
Do not create a system preference file in /etc.
.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\-i\fR \fIdirectory\fP, \fB\-\-install-dir\fR=\fIdirectory\fP
The xpi file will be installed in the specified directory.
.I directory
must be an absolute path. Use this parameter with care.
.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>