aboutsummaryrefslogtreecommitdiff
path: root/man/man1/src.1
diff options
context:
space:
mode:
authorrsc <devnull@localhost>2005-01-03 06:40:20 +0000
committerrsc <devnull@localhost>2005-01-03 06:40:20 +0000
commit058b0118a52061ad57694c01fc8763b22b789c4d (patch)
tree6685f04dea5ed68edaa34998c976aed34c55fe94 /man/man1/src.1
parent2600337aa704efbeba8201e88147a764b4fd2b90 (diff)
downloadplan9port-058b0118a52061ad57694c01fc8763b22b789c4d.tar.gz
plan9port-058b0118a52061ad57694c01fc8763b22b789c4d.tar.bz2
plan9port-058b0118a52061ad57694c01fc8763b22b789c4d.zip
Some man pages.
Diffstat (limited to 'man/man1/src.1')
-rw-r--r--man/man1/src.183
1 files changed, 83 insertions, 0 deletions
diff --git a/man/man1/src.1 b/man/man1/src.1
new file mode 100644
index 00000000..4c03dd7c
--- /dev/null
+++ b/man/man1/src.1
@@ -0,0 +1,83 @@
+.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
+.IR sam (1)).
+If
+.I file
+is an
+.IR 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
+.IR 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 /usr/local/plan9/bin/src
+.SH "SEE ALSO"
+.IR db (1),
+.IR plumb (1),
+.IR sam (1).