X-Git-Url: https://git.distorted.org.uk/~mdw/sw-tools/blobdiff_plain/f73dea5418f93116787314770a86804f6c763866..4216aeb54f91dd6bb717a524528e3d7d2b221716:/sw.1 diff --git a/sw.1 b/sw.1 index d06930a..9ed09ca 100644 --- a/sw.1 +++ b/sw.1 @@ -1,117 +1,15 @@ -.\" -*-nroff-*- -.\" -.\" $Id: sw.1,v 1.7 1999/07/30 18:44:33 mdw Exp $ -.\" -.\" Manual page for `sw' -.\" -.\" (c) 1999 EBI -.\" -. -.\"----- Licensing notice --------------------------------------------------- -.\" -.\" This file is part of sw-tools. -.\" -.\" sw-tools is free software; you can redistribute it and/or modify -.\" it under the terms of the GNU General Public License as published by -.\" the Free Software Foundation; either version 2 of the License, or -.\" (at your option) any later version. -.\" -.\" sw-tools is distributed in the hope that it will be useful, -.\" but WITHOUT ANY WARRANTY; without even the implied warranty of -.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.\" GNU General Public License for more details. -.\" -.\" You should have received a copy of the GNU General Public License -.\" along with sw-tools; if not, write to the Free Software Foundation, -.\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -. -.\"----- Revision history --------------------------------------------------- -.\" -.\" $Log: sw.1,v $ -.\" Revision 1.7 1999/07/30 18:44:33 mdw -.\" Improve cross-references and tidy up formatting. -.\" -.\" Revision 1.6 1999/07/30 08:18:23 mdw -.\" Sweep with ispell and fix some typos. -.\" -.\" Revision 1.5 1999/07/16 12:45:37 mdw -.\" Internal formatting improvements. -.\" -.\" Revision 1.4 1999/06/24 15:52:12 mdw -.\" Add documentation for the `sw-precommit' script. -.\" -.\" Revision 1.3 1999/06/18 18:58:25 mdw -.\" Various tidyings. -.\" -.\" Revision 1.2 1999/06/04 13:56:09 mdw -.\" Changes, extensions, polishings, spelling fixes... -.\" -.\" Revision 1.1.1.1 1999/06/02 16:53:33 mdw -.\" Initial import. -.\" -. -.\"----- Style hacking ------------------------------------------------------ -. -.de VS \" Start a sort-of verbatim block -.sp 1 -.in +5n -.nf -.ft B -.. -.de VE \" Stop a sort-of verbatim block -.ft R -.fi -.in -5n -.sp 1 -.. -.de hP \" Start an indented paragraph with a bold right-aligned label -.IP -\fB\h'-\w'\\$1\ 'u'\\$1\ \fP\c -.. -. -.ie \n(.g \{\ -. fam P -. ds mw \fR[\f(BImdw\fR] -.\} -.el .ds mw \fR[\fBmdw\fR] -.ie t .ds o \(bu -.el .ds o o -.ds sw \fBsw\fP -. -.\"----- Main manual text --------------------------------------------------- -. -.TH sw 1 "25 May 1999" sw-tools -.PD 1 -. -.\"-------------------------------------------------------------------------- -. -.SH "NAME" -. -sw \- tool for convenient software installation -. -.\"-------------------------------------------------------------------------- -. -.SH "SYNOPSIS" -. -.nf -\fBsw \-\-help -\fBsw \-\-help-full -\fBsw \-\-version -\fBsw \-\-archname -\fBsw \-\-remote \fIcommand - \fBsw all\-arch \fBsw arch \fBsw commit -\fBsw \fR[\fB\-fbi\fR] [\fB\-a \fIarch\fB,\fIarch\fR...] [\fB\-o \fIstyle\fR] \fBconfigure \fR[\fIconfigure-arg\fR...] +\fBsw \fR[\fB\-fbip\fR] [\fB\-a \fIarch\fB,\fIarch\fR...] [\fB\-o \fIstyle\fR] \fBconfigure \fR[\fIconfigure-arg\fR...] \fBsw host \fIarch \fBsw \fR[\fB\-f\fR] [\fB\-a \fIarch\fB,\fIarch\fR...] \fBlinktree \fBsw listarch -\fBsw \fR[\fB\-fbi\fR] [\fB\-a \fIarch\fB,\fIarch\fR...] [\fB\-o \fIstyle\fR] \fBmake \fR[\fImake-arg\fR...] +\fBsw \fR[\fB\-fbip\fR] [\fB\-a \fIarch\fB,\fIarch\fR...] [\fB\-o \fIstyle\fR] \fBmake \fR[\fImake-arg\fR...] \fBsw only\-arch \fIarch \fR[\fIarch\fR...] \fBsw reset \fBsw rsh \fIhost\fR|\fIarch \fR[\fIcommand \fR[\fIargument\fR...]] -\fBsw \fR[\fB\-fbi\fR] [\fB\-a \fIarch\fB,\fIarch\fR...] [\fB\-o \fIstyle\fR] \fBrun \fIcommand \fR[\fIargument\fR...] +\fBsw \fR[\fB\-fbip\fR] [\fB\-a \fIarch\fB,\fIarch\fR...] [\fB\-o \fIstyle\fR] \fBrun \fIcommand \fR[\fIargument\fR...] \fBsw setup \fIpackage version \fR[\fImaintainer\fR] \fBsw \fR[\fB\-f\fR] [\fB\-a \fIarch\fB,\fIarch\fR...] \fBsnaplink \fIfile \fR[\fIfile\fR...] \fBsw status @@ -502,7 +400,29 @@ for more details on output styles. .B "\-b, \-\-beep" For build commands: make a beep noise when the build finishes. This provides a handy reminder if you're getting on with something else while -waiting for a long build. +waiting for a long build. Use +.RB ` +b ' +or +.RB ` \-\-no\-beep ' +to turn this option off. This option is disabled by default, although +may be enabled in the +.B SW +environment variable. +.TP +.B "\-p, \-\-percent" +For build commands: enable translation of +.RB ` % '-escape +sequences in command strings. These are described in more detail +in the section +.B "`%'-escape sequences" +below. Use +.RB ` +p ' +or +.RB ` --no-percent ' +to turn the option off. This option is enabled by default, although may +be disabled in the +.B SW +environment variable. .PP The remaining options aren't really intended for users. They're helpful for \*(sw's own purposes, though, and described here for completeness' sake. They @@ -804,6 +724,16 @@ Executes the program named passing it the given .IR argument s. .PP +The command name and arguments may be subject to +.RB ` % '-escape +substitution, depending on whether the +.B \-p +option is enabled. +.RB ` % '-escape +sequences are described in the section +.B "`%'-escape sequences" +below. +.PP Output from the command is both appended to the file .IB arch/.build-log and output in some @@ -869,6 +799,46 @@ actually need to follow creation of link trees. . .\"-------------------------------------------------------------------------- . +.SH "`%'-ESCAPE SUBSTITUTION" +. +If the +.B \-p +option is enabled, build commands and arguments are subject to +.RB ` % '-escape +substitution before being executed. Certain two-character sequences, +with the first character +.RB ` % ' +are replaced with strings, as follows: +.TP +.B %a +The architecture name of the host executing the command. +.TP +.B %h +The hostname of the host executing the command. +.TP +.B %P +The directory prefix with which \*(sw was installed. +.TP +.B %p +The name of the package being built. +.TP +.B %v +The version number of the package being built. +.TP +.B %u +The name of the maintainer of the package being built. +.TP +.B %% +A literal +.RB ` % ' +character. +.PP +Any +.RB ` % ' +sequences which aren't understood are left as they are. +. +.\"-------------------------------------------------------------------------- +. .SH "OUTPUT STYLES" . Output from a build command is presented in one of a number of named