10564b1175
groff 1.23.0 added .MR to its -man macro package. The NEWS file states
that the inclusion of the macro "was prompted by its introduction to
Plan 9 from User Space's troff in August 2020." From d32deab it seems
that the name for Plan 9 from User Space's implementation was suggested
by groff maintainer G. Brandon Robinson.
Not sure if the intention was to make these definitions compatible, but
it would be nice if they were.
Currently, Plan 9 from User Space's .MR expects its second argument to
be parenthesized. groff's .MR does not. This results in extra
parentheses appearing in manual references when viewing Plan 9 from User
Space's manual pages on a system using groff.
84 lines
1.1 KiB
Groff
84 lines
1.1 KiB
Groff
.TH SRC 1
|
|
.SH NAME
|
|
src \- find source code for executable
|
|
.SH SYNOPSIS
|
|
.B src
|
|
[
|
|
.B -n
|
|
]
|
|
[
|
|
.B -s
|
|
.I symbol
|
|
]
|
|
.I file
|
|
.B ...
|
|
.SH DESCRIPTION
|
|
.I Src
|
|
examines the named
|
|
.I files
|
|
to find the corresponding source code, which is then sent to the editor using
|
|
.B B
|
|
(see
|
|
.MR sam 1 ).
|
|
If
|
|
.I file
|
|
is an
|
|
.MR rc 1
|
|
script, the source is the file itself.
|
|
If
|
|
.I file
|
|
is an executable, the source is defined to be the single file containing the
|
|
definition of
|
|
.B main
|
|
and
|
|
.I src
|
|
will point the editor at the line that begins the definition.
|
|
.I Src
|
|
uses
|
|
.MR db 1
|
|
to extract the symbol table information that identifies the source.
|
|
.PP
|
|
.I Src
|
|
looks for each
|
|
.I file
|
|
in the current directory, in
|
|
.BR /bin ,
|
|
and in the subdirectories of
|
|
.BR /bin ,
|
|
in that order.
|
|
.PP
|
|
The
|
|
.B -n
|
|
flag causes
|
|
.B src
|
|
to print the file name but not send it to the editor.
|
|
The
|
|
.B -s
|
|
flag identifies a
|
|
.I symbol
|
|
other than
|
|
.B main
|
|
to locate.
|
|
.SH EXAMPLES
|
|
Find the source to the
|
|
.B main
|
|
routine in
|
|
.BR /bin/ed :
|
|
.IP
|
|
.EX
|
|
src ed
|
|
.EE
|
|
.PP
|
|
Find the source for
|
|
.BR strcmp :
|
|
.IP
|
|
.EX
|
|
src -s strcmp rc
|
|
.EE
|
|
.SH SOURCE
|
|
.B \*9/bin/src
|
|
.SH "SEE ALSO"
|
|
.MR db 1 ,
|
|
.MR plumb 1 ,
|
|
.MR sam 1 .
|