dcf8bf5606
- add --docdir so that :help works - add --verbose - fix a bug in the ")" command that could cause a segfault - fix a bug when lauching elvis in a directory containing a "tags" dir - make file/syntax detection work for scripts using "env" - add "return" to the list of shell script keywords - fix a few things in the man pages (\-, typo, whitespace) since we were already patching them.
64 lines
2.4 KiB
Plaintext
64 lines
2.4 KiB
Plaintext
$OpenBSD: patch-doc_ref_man,v 1.1 2012/05/05 14:03:15 sthen Exp $
|
|
--- doc/ref.man.orig Tue Oct 21 04:32:26 2003
|
|
+++ doc/ref.man Sat May 5 13:48:30 2012
|
|
@@ -17,7 +17,7 @@ See
|
|
quickly locates and displays the header of a function.
|
|
To do this,
|
|
.B ref
|
|
-looks in the "tags" file for the line that describes the function, and then
|
|
+looks in the "tags" file for the line that describes the function, and then
|
|
scans the source file for the function.
|
|
When it locates the function, it displays an introductory comment
|
|
(if there is one), the function's declaration, and the declarations of all
|
|
@@ -28,8 +28,8 @@ Output tag info, instead of the function header.
|
|
The tag info consists of the three standard fields from each tag.
|
|
The fields will be separated by tab characters, just like records from the
|
|
traditional tags file format.
|
|
-Consequently, you can use "ref -t -a >oldtags" to convert a new-style tags file
|
|
-back to an old-style tags file.
|
|
+Consequently, you can use "ref \-t \-a >oldtags" to convert a new-style tags
|
|
+file back to an old-style tags file.
|
|
.IP \fB-v\fR
|
|
Output verbose tag info, instead of the function header.
|
|
The verbose tag info shows the names and values of all attributes for each
|
|
@@ -65,7 +65,7 @@ would only output the single most likely tag.)
|
|
Search all tags files.
|
|
Without this option,
|
|
.B ref
|
|
-would stop searching after processing the first tags file which
|
|
+would stop searching after processing the first tags file which
|
|
contained any tags which met the restrictions.
|
|
.IP "\fB-p\fI tagpath\fR"
|
|
List of directories or tags files to search through.
|
|
@@ -122,7 +122,7 @@ global tags whose address mentions "Foo" \-
|
|
probably friends of the Foo class.
|
|
.TP
|
|
.IB value [, value ...]
|
|
-Short for
|
|
+Short for
|
|
.BI tagname: value [, value ...]
|
|
.PP
|
|
The sorting hints follow a similar form:
|
|
@@ -160,10 +160,10 @@ I needed to generate extern declarations for all the f
|
|
To find the global function headers, I used the command...
|
|
.nf
|
|
|
|
- ref -a kind:f file:dummy
|
|
+ ref \-a kind:f file:dummy
|
|
.fi
|
|
.PP
|
|
-The "-a" causes
|
|
+The "\-a" causes
|
|
.B ref
|
|
to output all headers, instead of just the first one that it finds.
|
|
"kind:f" causes it to exclude any non-functions.
|
|
@@ -184,7 +184,7 @@ For each source file, I also needed to find the static
|
|
there, so for each "file.c" I used the command...
|
|
.nf
|
|
|
|
- ref -a kind:f file:=file.c
|
|
+ ref \-a kind:f file:=file.c
|
|
.fi
|
|
.PP
|
|
This is very similar to the earlier command.
|