plan9port/man/man1/label.1
Russ Cox 977b25a76a tmac: introduce real manual reference macro instead of overloading IR
The overloading of IR emits magic \X'...' sequences that turn into HTML manual links.
But not all such IR invocations should be manual links;
those had to be written to avoid the IR macro before.
Worse, the \X'...' ending the IR causes troff to emit only a single space after a period.

Defining a new IM macro for manual references fixes both problems.

Fixes #441.
2020-08-13 23:43:43 -04:00

80 lines
1.2 KiB
Groff

.TH LABEL 1
.SH NAME
label, awd \- set window label
.SH SYNOPSIS
.B label
.I string
.br
.B awd
[
.I sysname
]
.SH DESCRIPTION
.I Label
sets the label of the current
.I win
(see
.IM acme (1) )
or X terminal window
.RI ( e.g.,
.IM 9term (1)
or
.IM xterm (1) )
by echoing a special control sequence to standard output.
.PP
.I Acme
and
.I 9term
windows assume the label is a directory name.
When unrooted file names are plumbed in the window,
they are evaluated relative to the directory named in the label.
.PP
The label may have a suffix
.BI /- sysname \fR,
which is not interpreted as part of the directory during plumbing.
.I Awd
sets the window name to the current directory with a
.BI /- sysname
suffix, using the name of the current system by default.
.SH EXAMPLE
One can use the following
.IM sh (1)
function to keep the label up-to-date in response to
.I cd
commands:
.IP
.EX
_cd () {
\ecd "$@" &&
case $- in
*i*)
awd
esac
}
alias cd=_cd
cd .
.EE
.PP
.IM Rc (1)
installs a similar
.B fn
.B cd
at startup if there is not already a function named
.BR cd :
.IP
.EX
fn cd {
if(builtin cd $1){
if(flag i) $PLAN9/bin/9 awd || status=''
status=''
}
}
.EE
.SH SOURCE
.B \*9/bin/label
.br
.B \*9/bin/awd
.SH BUGS
.I Awd
is also documented in
.IM acme (1) .