X-Git-Url: https://git.distorted.org.uk/~mdw/sw-tools/blobdiff_plain/f73dea5418f93116787314770a86804f6c763866..9efcd1779c515c1492ff76a74319936d41e12c0b:/sw.1

diff --git a/sw.1 b/sw.1
index d06930a..80af91d 100644
--- a/sw.1
+++ b/sw.1
@@ -1,6 +1,6 @@
 .\" -*-nroff-*-
 .\"
-.\" $Id: sw.1,v 1.7 1999/07/30 18:44:33 mdw Exp $
+.\" $Id: sw.1,v 1.9 1999/09/16 12:34:13 mdw Exp $
 .\"
 .\" Manual page for `sw'
 .\"
@@ -28,6 +28,12 @@
 .\"----- Revision history ---------------------------------------------------
 .\"
 .\" $Log: sw.1,v $
+.\" Revision 1.9  1999/09/16 12:34:13  mdw
+.\" Fix stupid typo.
+.\"
+.\" Revision 1.8  1999/09/10 15:27:40  mdw
+.\" Include `%'-escape substitution.
+.\"
 .\" Revision 1.7  1999/07/30 18:44:33  mdw
 .\" Improve cross-references and tidy up formatting.
 .\"
@@ -103,15 +109,15 @@ sw \- tool for convenient software installation
 \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 +508,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 +832,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 +907,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