man: update man pages to say $HOME when accurate

Fixes #386.
This commit is contained in:
Russ Cox 2020-05-18 23:51:35 -04:00
parent d25d0ca1a3
commit bfe4377e40
4 changed files with 37 additions and 33 deletions

View file

@ -48,7 +48,7 @@ is a programmable symbolic debugger.
It can inspect one or more processes that share an address space. It can inspect one or more processes that share an address space.
A program to be debugged may be specified by the process id of A program to be debugged may be specified by the process id of
a running or defunct process, a running or defunct process,
or by the name of the program's text file or by the name of the program's text file
.RB ( a.out .RB ( a.out
by default). by default).
At the prompt, At the prompt,
@ -63,7 +63,7 @@ Allow the textfile to be modified.
Print variable renamings at startup. Print variable renamings at startup.
.TP .TP
.BI -l " library .BI -l " library
Load from Load from
.I library .I library
at startup; see below. at startup; see below.
.TP .TP
@ -84,8 +84,8 @@ obtains standard function definitions from the library file
architecture-dependent functions from architecture-dependent functions from
.BR \*9/acid/$objtype , .BR \*9/acid/$objtype ,
user-specified functions from user-specified functions from
.BR $home/lib/acid , .BR $HOME/lib/acid ,
and further functions from and further functions from
.B -l .B -l
files. files.
Definitions in any file may override previously defined functions. Definitions in any file may override previously defined functions.
@ -106,7 +106,7 @@ to create
.I acid .I acid
functions for examining data structures. functions for examining data structures.
.SS Language .SS Language
Symbols of the program being debugged become integer Symbols of the program being debugged become integer
variables whose values are addresses. variables whose values are addresses.
Contents of addresses are obtained by indirection. Contents of addresses are obtained by indirection.
Local variables are qualified by Local variables are qualified by
@ -114,7 +114,7 @@ function name, for example
.BR main:argv . .BR main:argv .
When program symbols conflict with When program symbols conflict with
.I acid .I acid
words, distinguishing words, distinguishing
.B $ .B $
signs are prefixed. signs are prefixed.
Such renamings are reported at startup; option Such renamings are reported at startup; option
@ -127,7 +127,7 @@ and formats are inferred from assignments.
Truth values false/true are attributed to zero/nonzero Truth values false/true are attributed to zero/nonzero
integers or floats and to empty/nonempty lists or strings. integers or floats and to empty/nonempty lists or strings.
Lists are sequences of expressions surrounded by Lists are sequences of expressions surrounded by
.BR {\^} .BR {\^}
and separated by commas. and separated by commas.
.PP .PP
Expressions are much as in C, Expressions are much as in C,
@ -219,7 +219,7 @@ Same as
.BR spr();gpr() . .BR spr();gpr() .
.TP .TP
.BI fmt( expr , format ) .BI fmt( expr , format )
Expression Expression
.I expr .I expr
with format given by the character value of expression with format given by the character value of expression
.IR format . .IR format .
@ -243,7 +243,7 @@ List current source directories.
Add a source directory to the list. Add a source directory to the list.
.TP .TP
.BI filepc( where ) .BI filepc( where )
Convert a string of the form Convert a string of the form
.IB sourcefile : linenumber .IB sourcefile : linenumber
to a machine address. to a machine address.
.TP .TP
@ -288,7 +288,7 @@ interpreted according to a string of format codes.
.BI dump( address , n , string\fP) .BI dump( address , n , string\fP)
Like Like
.BR mem (), .BR mem (),
repeated for repeated for
.I n .I n
consecutive blocks. consecutive blocks.
.TP .TP
@ -300,7 +300,7 @@ Start a new process with arguments given as a string
and halt at the first instruction. and halt at the first instruction.
.TP .TP
.B new() .B new()
Like Like
.IR newproc (), .IR newproc (),
but take arguments (except but take arguments (except
.BR argv[0] ) .BR argv[0] )
@ -308,7 +308,7 @@ from string variable
.BR progargs . .BR progargs .
.TP .TP
.B win() .B win()
Like Like
.IR new (), .IR new (),
but run the process in a separate window. but run the process in a separate window.
.TP .TP
@ -337,7 +337,7 @@ When a pid or core file is specified on the command line,
.I acid .I acid
will, as part of its startup, determine the set of shared libraries will, as part of its startup, determine the set of shared libraries
in use by the process image and map those at appropriate locations. in use by the process image and map those at appropriate locations.
If If
.I acid .I acid
is started without a pid or core file is started without a pid or core file
and is subsequently attached to a process via and is subsequently attached to a process via
@ -414,7 +414,7 @@ acid: *argv0
acid: bpset(ls) acid: bpset(ls)
acid: cont() acid: cont()
70094: breakpoint ls ADD $-0x16c8,R29 70094: breakpoint ls ADD $-0x16c8,R29
acid: acid:
.EE .EE
.PP .PP
Display elements of a linked list of structures: Display elements of a linked list of structures:
@ -499,7 +499,7 @@ acid: cont()
.br .br
.B \*9/acid/truss .B \*9/acid/truss
.br .br
.B $home/lib/acid .B $HOME/lib/acid
.SH SOURCE .SH SOURCE
.B \*9/src/cmd/acid .B \*9/src/cmd/acid
.SH "SEE ALSO" .SH "SEE ALSO"

View file

@ -300,7 +300,7 @@ Delete window without checking for dirtiness.
Write the state of Write the state of
.I acme .I acme
to the file name, if specified, or to the file name, if specified, or
.B $home/acme.dump .B $HOME/acme.dump
by default. by default.
.TP .TP
.B Edit .B Edit
@ -403,7 +403,7 @@ commands named as arguments.
Restore the state of Restore the state of
.I acme .I acme
from a file (default from a file (default
.BR $home/acme.dump ) .BR $HOME/acme.dump )
created by the created by the
.B Dump .B Dump
command. command.
@ -745,9 +745,9 @@ and
.I awd .I awd
reside. reside.
.SH FILES .SH FILES
.TF $home/acme.dump .TF $HOME/acme.dump
.TP .TP
.B $home/acme.dump .B $HOME/acme.dump
default file for default file for
.B Dump .B Dump
and and

View file

@ -806,6 +806,10 @@ is set to its process id.
.B $home .B $home
The default directory for The default directory for
.BR cd . .BR cd .
Defaults to
.B $HOME
or else
.LR / .
.TP .TP
.B $ifs .B $ifs
The input field separators used in backquote substitutions. The input field separators used in backquote substitutions.

View file

@ -1,7 +1,7 @@
.TH SAM 1 .TH SAM 1
.ds a \fR*\ \fP .ds a \fR*\ \fP
.SH NAME .SH NAME
sam, B, E, sam.save, samterm, samsave \- screen editor with structural regular expressions sam, B, E, sam.save, samterm, samsave \- screen editor with structural regular expressions
.SH SYNOPSIS .SH SYNOPSIS
.B sam .B sam
[ [
@ -43,7 +43,7 @@ The options are
.TP .TP
.B -a .B -a
Autoindent. In this mode, when a newline character is typed Autoindent. In this mode, when a newline character is typed
in the terminal interface, in the terminal interface,
.I samterm .I samterm
copies leading white space on the current line to the new line. copies leading white space on the current line to the new line.
.TP .TP
@ -121,7 +121,7 @@ is the beginning of the file.
.TP .TP
.BI ? regexp ? .BI ? regexp ?
The substring that matches the regular expression, The substring that matches the regular expression,
found by looking toward the end found by looking toward the end
.RB ( / ) .RB ( / )
or beginning or beginning
.RB ( ? ) .RB ( ? )
@ -248,7 +248,7 @@ or
is reversed. is reversed.
.PP .PP
It is an error for a compound address to represent a malformed substring. It is an error for a compound address to represent a malformed substring.
Some useful idioms: Some useful idioms:
.IB a1 +- .IB a1 +-
\%(\f2a1\fB-+\f1) \%(\f2a1\fB-+\f1)
selects the line containing selects the line containing
@ -258,7 +258,7 @@ locates the first match of the expression in the file.
(The form (The form
.B 0;// .B 0;//
sets dot unnecessarily.) sets dot unnecessarily.)
.BI ./ regexp /// .BI ./ regexp ///
finds the second following occurrence of the expression, finds the second following occurrence of the expression,
and and
.BI .,/ regexp / .BI .,/ regexp /
@ -276,7 +276,7 @@ newline may not appear literally;
.B \en .B \en
may be typed for newline; and may be typed for newline; and
.B \e/ .B \e/
quotes the delimiter, here quotes the delimiter, here
.LR / . .LR / .
Backslash is otherwise interpreted literally, except in Backslash is otherwise interpreted literally, except in
.B s .B s
@ -284,7 +284,7 @@ commands.
.PP .PP
Most commands may be prefixed by an address to indicate their range Most commands may be prefixed by an address to indicate their range
of operation. of operation.
Those that may not are marked with a Those that may not are marked with a
.L * .L *
below. below.
If a command takes If a command takes
@ -347,12 +347,12 @@ Substitute
.I text .I text
for the first match to the regular expression in the range. for the first match to the regular expression in the range.
Set dot to the modified range. Set dot to the modified range.
In In
.I text .I text
the character the character
.B & .B &
stands for the string stands for the string
that matched the expression. that matched the expression.
Backslash behaves as usual unless followed by Backslash behaves as usual unless followed by
a digit: a digit:
.BI \e d .BI \e d
@ -500,7 +500,7 @@ Plan 9 command.
.BI \*acd " directory .BI \*acd " directory
Change working directory. Change working directory.
If no directory is specified, If no directory is specified,
.B $home .B $HOME
is used. is used.
.PD .PD
.PP .PP
@ -543,7 +543,7 @@ For each match of the regular expression in the range, run the command
with dot set to the match. with dot set to the match.
Set dot to the last match. Set dot to the last match.
If the regular If the regular
expression and its slashes are omitted, expression and its slashes are omitted,
.L /.*\en/ .L /.*\en/
is assumed. is assumed.
Null string matches potentially occur before every character Null string matches potentially occur before every character
@ -652,7 +652,7 @@ If no address is specified (the
command is a newline) dot is extended in either direction to command is a newline) dot is extended in either direction to
line boundaries and printed. line boundaries and printed.
If dot is thereby unchanged, it is set to If dot is thereby unchanged, it is set to
.B .+1 .B .+1
and printed. and printed.
.PD .PD
.SS Grouping and multiple changes .SS Grouping and multiple changes
@ -713,7 +713,7 @@ of a rectangle.
from the command window or the whole screen, depending on from the command window or the whole screen, depending on
where the null rectangle is. where the null rectangle is.
.TF resize .TF resize
.TP .TP
.B new .B new
Create a new, empty file. Create a new, empty file.
.TP .TP
@ -819,7 +819,7 @@ typed in a command.
Send the text in dot, or the snarf buffer if Send the text in dot, or the snarf buffer if
dot is the null string, as if it were typed to the command window. dot is the null string, as if it were typed to the command window.
Saves the sent text in the snarf buffer. Saves the sent text in the snarf buffer.
(Command window only.) (Command window only.)
.PD .PD
.SS Simulated buttons .SS Simulated buttons
For systems without a three-button mouse, the keyboard modifier For systems without a three-button mouse, the keyboard modifier