| 1 |
.\" -*-nroff-*- |
| 2 |
.TH "GAUCHE\-INSTALL" "1" "" "Gauche @GAUCHE_VERSION@" "Gauche Commands" |
| 3 |
.\" disable hyphenation |
| 4 |
.nh |
| 5 |
.\" disable justification (adjust text to left margin only) |
| 6 |
.ad l |
| 7 |
.SH "NAME" |
| 8 |
gauche-install \- install files and set attributes |
| 9 |
.SH "SYNOPSIS" |
| 10 |
1)* \fBgauche\-install\fR [\fB\fIOPTION\fR\fR...] \fB\fIFILE\fR\fR \fB\fIDEST\fR\fR |
| 11 |
2)* \fBgauche\-install\fR [\fB\fIOPTION\fR\fR...] \fB\fIFILE\fR\fR... \fB\fIDIRECTORY\fR\fR |
| 12 |
3)* \fBgauche\-install\fR \fB\-d\fR [\fB\fIOPTION\fR\fR...] \fB\fIDIRECTORY\fR\fR... |
| 13 |
4) \fBgauche\-install\fR \fB\-T\fR \fIDIRECTORY\fR [\fB\fIOPTION\fR\fR...] \fB\fIFILE\fR\fR... |
| 14 |
5) \fBgauche\-install\fR \fB\-U\fR \fIDIRECTORY\fR [\fB\fIOPTION\fR\fR...] \fB\fIFILE\fR\fR... |
| 15 |
.SH "DESCRIPTION" |
| 16 |
.PP |
| 17 |
\fBgauche\-install\fR |
| 18 |
is a program to install and remove files\&. |
| 19 |
On installation it allows to set ownership and permissions\&. |
| 20 |
This command is upward compatible with BSD install(1) and can be |
| 21 |
used as a drop-in replacement of it. Notably, |
| 22 |
1st, 2nd and 3rd command-line format above are compatible with BSD install. |
| 23 |
.PP |
| 24 |
This command is provided mainly for Gauche's extension packages |
| 25 |
to have simpler installation and configuration process. Being certain |
| 26 |
that gauche\-install is available, those packages don't need to |
| 27 |
worry about subtle differences between various install(1) commands. |
| 28 |
.PP |
| 29 |
The first format copies |
| 30 |
.I FILE |
| 31 |
on the file or in the directory named by |
| 32 |
.I DEST\&. |
| 33 |
The second format copies |
| 34 |
.I FILE ... |
| 35 |
into the directory |
| 36 |
.IR DIRECTORY . |
| 37 |
.PP |
| 38 |
The third format ensures |
| 39 |
.I DIRECTORY |
| 40 |
exists. If it doesn't, the command creates the path to the |
| 41 |
.I DIRECTORY , |
| 42 |
including any intermediate ones. |
| 43 |
.PP |
| 44 |
The fourth format installing |
| 45 |
.I FILE ... |
| 46 |
to the |
| 47 |
.IR DIRECTORY . |
| 48 |
It is more convenient than the first and second formats in |
| 49 |
the following regards: |
| 50 |
.IP "" 3 |
| 51 |
* If the destination directory does not exist, it is created |
| 52 |
(with any intermediate paths as needed). |
| 53 |
.IP "" 3 |
| 54 |
* The list of files can be empty, so that when the list of |
| 55 |
installed files can be generated by configuration, you don't |
| 56 |
need to handle the empty case specially in Makefile. |
| 57 |
(With BSD install format, empty file list yields an error.) |
| 58 |
.IP "" 3 |
| 59 |
* The directory prefix of files are preserved within the |
| 60 |
destination directory. This is handy to install subtree of files. |
| 61 |
For example, the following command installs '/usr/share/foo/main', |
| 62 |
\&'/usr/share/foo/conf/x' and '/usr/share/foo/conf/y' with a |
| 63 |
single command. |
| 64 |
|
| 65 |
gauche-install -T /usr/share/foo main conf/x conf/y |
| 66 |
|
| 67 |
Giving \fB\-p\fR option suppresses this behavior and |
| 68 |
strips any directory prefix like the second format. The |
| 69 |
following command line installs '/usr/share/foo/main', |
| 70 |
\&'/usr/share/foo/x' and '/usr/share/foo/y'. |
| 71 |
|
| 72 |
gauche-install -T /usr/share/foo -p main conf/x conf/y |
| 73 |
.PP |
| 74 |
The fifth format removes |
| 75 |
.I FILE ... |
| 76 |
in the |
| 77 |
.IR DIRECTORY . |
| 78 |
Irrelevant options are ignored, so it is handy to uninstall |
| 79 |
files just by changing \fB\-T\fR in the fourth format to \fB\-U\fR. |
| 80 |
.SH "OPTIONS" |
| 81 |
.PP |
| 82 |
\fB\-C\fR, \fB\-\-canonical\-suffix\fR |
| 83 |
.RS 4 |
| 84 |
This is used specially to install Gauche's autogenerated |
| 85 |
Scheme source by experimental precompilation. The generated file |
| 86 |
has a *\&.sci. Upon installation, this command replaces the suffix |
| 87 |
for *\&.scm\&. |
| 88 |
.RE |
| 89 |
.PP |
| 90 |
\fB\-d\fR, \fB\-\-directory\fR |
| 91 |
.RS 4 |
| 92 |
Creates directories\&. (3rd format only)\&. It is only for the compatibility. |
| 93 |
Using the \fB\-T\fR option, the destination directories are created |
| 94 |
automatically if missing. |
| 95 |
.RE |
| 96 |
.PP |
| 97 |
\fB\-g\fR, \fB\-\-group=\fR\fIGROUP\fR |
| 98 |
.RS 4 |
| 99 |
Change group of the installed file\&. |
| 100 |
.RE |
| 101 |
.PP |
| 102 |
\fB\-h\fR, \fB\-\-help\fR |
| 103 |
.RS 4 |
| 104 |
Show summary of options\&. |
| 105 |
.RE |
| 106 |
.PP |
| 107 |
\fB\-m\fR, \fB\-\-mode=\fR\fIMODE\fR |
| 108 |
.RS 4 |
| 109 |
Change mode of the installed file\&. |
| 110 |
.RE |
| 111 |
.PP |
| 112 |
\fB\-n\fR, \fB\-\-dry\-run\fR |
| 113 |
.RS 4 |
| 114 |
Just prints what actions to be done\&. |
| 115 |
.RE |
| 116 |
.PP |
| 117 |
\fB\-o\fR, \fB\-\-owner=\fR\fIOWNER\fR |
| 118 |
.RS 4 |
| 119 |
Change owner of the installed file\&. |
| 120 |
.RE |
| 121 |
.PP |
| 122 |
\fB\-p\fR, \fB\-\-strip\-prefix=\fR\fIPREFIX\fR |
| 123 |
.RS 4 |
| 124 |
Strip |
| 125 |
\fIPREFIX\fR |
| 126 |
directories from |
| 127 |
\fIFILE\fR(s) before installation\&. (4th/5th format only)\&. |
| 128 |
.RE |
| 129 |
.PP |
| 130 |
\fB\-\-shebang=\fR\fB\fIPATH\fR\fR |
| 131 |
.RS 4 |
| 132 |
Adds #!PATH before the file contents\&. Useful to install scripts\&. |
| 133 |
.RE |
| 134 |
.PP |
| 135 |
\fB\-S\fR, \fB\-\-srcdir=\fR\fB\fIdirectory\fR\fR |
| 136 |
.RS 4 |
| 137 |
Look for files within \fIdirectory\fR; useful if VPATH is used |
| 138 |
in Makefiles. |
| 139 |
.RE |
| 140 |
.PP |
| 141 |
\fB\-T\fR, \fB\-\-target=\fR\fB\fIdirectory\fR\fR |
| 142 |
.RS 4 |
| 143 |
Installs files to the |
| 144 |
\fIdirectory\fR, creating paths if needed\&. |
| 145 |
Partial path of files are preserved unless \fB\-p\fR option is given\&. |
| 146 |
(4th format only) |
| 147 |
.RE |
| 148 |
.PP |
| 149 |
\fB\-U\fR, \fB\-\-uninstall=\fR\fB\fIdirectory\fR\fR |
| 150 |
.RS 4 |
| 151 |
Reverse of |
| 152 |
\fB\-T\fR, e\&.g\&. removes files from its destination\&. |
| 153 |
Other options (except \fB\-h\fR and \fB\-n\fR) are ignored. |
| 154 |
.RE |
| 155 |
.PP |
| 156 |
\fB\-v\fR, \fB\-\-verbose\fR |
| 157 |
.RS 4 |
| 158 |
Work verbosely\&. |
| 159 |
.RE |
| 160 |
.SH "DIAGNOSTICS" |
| 161 |
.PP |
| 162 |
\fBgauche\-install\fR |
| 163 |
exits with status 0 on success\&. |
| 164 |
.SH "SEE ALSO" |
| 165 |
.PP |
| 166 |
\fBgauche-package\fR(1), |
| 167 |
\fBinstall\fR(1) |
| 168 |
.PP |
| 169 |
The program will be documented fully by the |
| 170 |
Gauche Developers\' Reference |
| 171 |
available via the |
| 172 |
\fBinfo\fR(1) |
| 173 |
system\&. |
| 174 |
.SH "AUTHORS" |
| 175 |
.PP |
| 176 |
\fBShiro Kawai\fR <\&shiro@acm\&.org\&> |
| 177 |
.sp -1n |
| 178 |
.IP "" 4 |
| 179 |
Author. |
| 180 |
.PP |
| 181 |
\fBJens Thiele\fR <\&karme@karme\&.de\&> |
| 182 |
.sp -1n |
| 183 |
.IP "" 4 |
| 184 |
Wrote this manpage for the Debian system\&. |
| 185 |
.SH "COPYRIGHT" |
| 186 |
Copyright \(co 2010 Jens Thiele |
| 187 |
.br |
| 188 |
.PP |
| 189 |
Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved\&. This file is offered as\-is, without any warranty\&. |
| 190 |
.sp |