[Cscope-cvs] CVS: cscope/doc cscope.1,1.17,1.18

[Hans-Bernhard B. <br...@us...>]

Update of /cvsroot/cscope/cscope/doc
In directory sc8-pr-cvs1:/tmp/cvs-serv27729/doc

Modified Files:
	cscope.1 
Log Message:
Cleaned up manpage, INSTALL and TODO files

Index: cscope.1
===================================================================
RCS file: /cvsroot/cscope/cscope/doc/cscope.1,v
retrieving revision 1.17
retrieving revision 1.18
diff -C2 -r1.17 -r1.18
*** cscope.1	12 Jun 2003 17:11:38 -0000	1.17
--- cscope.1	14 Aug 2003 14:37:48 -0000	1.18
***************
*** 1,17 ****
  .PU
! .TH CSCOPE "1" "November 2000" "The Santa Cruz Operation"
  .SH NAME
  cscope - interactively examine a C program 
  .SH SYNOPSIS
- .ll +8
  .B cscope
! .RB [ " -bCcdehkLlqRTUuVv " ]
! .RB [ -F symfile  ]
! .RB [ -f reffile  ]
! .RB [ -I incdir  ]
! .RB [ -i namefile  ]
! .RB [ -num pattern  ]
! .RB [ -p n  ]
! .RB [ -s dir  ]
  .SH DESCRIPTION
  .I cscope
--- 1,17 ----
  .PU
! .TH CSCOPE "1" "August 2003" "The Santa Cruz Operation"
  .SH NAME
  cscope - interactively examine a C program 
  .SH SYNOPSIS
  .B cscope
! .B [\-bCcdehkLlqRTUuVv]
! .BI [\-F symfile ]
! .BI [\-f reffile ]
! .BI [\-I incdir ]
! .BI [\-i namefile ]
! .BI [\-[ 0-9 ] pattern ]
! .BI [\-p n ]
! .BI [\-s dir ]
! .BI [ files ]
  .SH DESCRIPTION
  .I cscope
***************
*** 30,34 ****
  find in the current directory. 
  .I cscope
! uses a symbol cross-reference,
  cscope.out by default, to locate functions, function calls, macros,
  variables, and preprocessor symbols in the files.
--- 30,34 ----
  find in the current directory. 
  .I cscope
! uses a symbol cross-reference, called 
  cscope.out by default, to locate functions, function calls, macros,
  variables, and preprocessor symbols in the files.
***************
*** 45,48 ****
--- 45,67 ----
  than the initial build.
  .SH OPTIONS  
+ Some command line arguments can only occur as the the ony argument in
+ the execution of cscope.  They cause the program to just print out
+ some output and exit immediately:
+ .TP
+ .B -h
+ View the long usage help display.
+ .TP
+ .B -V
+ Print on the first line of screen the version number of cscope.
+ .TP
+ .B --help
+ Same as
+ .B -h
+ .TP
+ .B --version
+ Same as
+ .B -V
+ 
+ .PP
  The following options can appear in any combination:
  .TP
***************
*** 63,84 ****
  Suppress the <Ctrl>-e command prompt between files.
  .TP
! .B -F symfile
! Read symbol reference lines from symfile. (A symbol reference
  file is created by > and >>, and can also be read using the <
  command, described under ``Issuing Subsequent Requests,''
  below.)
  .TP
! .B -f reffile
! Use reffile as the cross-reference file name instead of the
! default cscope.out.
! .TP
! .B -h
! View the long usage help display.
! .TP
! .B -I incdir
! Look in incdir (before looking in INCDIR, the standard place
  for header files, normally /usr/include) for any #include files
  whose names do not begin with ``/'' and that are not specified
! on the command line or in namefile below. (The #include files
  may be specified with either double quotes or angle brackets.)
  The incdir directory is searched in addition to the current
--- 82,107 ----
  Suppress the <Ctrl>-e command prompt between files.
  .TP
! .BI -F symfile
! Read symbol reference lines from 
! .I symfile. 
! (A symbol reference
  file is created by > and >>, and can also be read using the <
  command, described under ``Issuing Subsequent Requests,''
  below.)
  .TP
! .BI -f reffile
! Use 
! .I reffile 
! as the cross-reference file name instead of the default "cscope.out".
! .TP
! .BI -I incdir
! Look in 
! .I incdir 
! (before looking in $INCDIR, the standard place
  for header files, normally /usr/include) for any #include files
  whose names do not begin with ``/'' and that are not specified
! on the command line or in 
! .I namefile 
! below. (The #include files
  may be specified with either double quotes or angle brackets.)
  The incdir directory is searched in addition to the current
***************
*** 88,100 ****
  on the command line.
  .TP
! .B -i namefile
! Browse through all source files whose names are listed in namefile
  (file names separated by spaces, tabs, or new-lines) instead of the
! default (cscope.files). If this option is specified, cscope ignores
! any files appearing on the command line. The argument namefile can be
! set to ``-'' to accept a list of files from stdio.  Filenames in the
! namefile that contain whitespace have to be enclosed in "double
! quotes".  Inside such quoted filenames, any double-quote and backslash
! characters have to be escaped by backslashes.
  .TP
  .B -k
--- 111,125 ----
  on the command line.
  .TP
! .BI -i namefile
! Browse through all source files whose names are listed in 
! .I namefile
  (file names separated by spaces, tabs, or new-lines) instead of the
! default name list file, which is called cscope.files. If this option
! is specified, cscope ignores any file names appearing on the command
! line. The argument namefile can be set to ``-'' to accept a list of
! files from the standard input.  Filenames in the namefile that contain
! whitespace have to be enclosed in "double quotes".  Inside such quoted
! filenames, any double-quote and backslash characters have to be
! escaped by backslashes.
  .TP
  .B -k
***************
*** 111,126 ****
  below).
  .TP
! .B -num pattern
! Go to input field num (counting from 0) and find pattern.
! .TP
! .B -P path
! Prepend path to relative file names in a pre-built
! cross-reference file so you do not have to change to the
! directory where the cross-reference file was built. This option
! is only valid with the -d option.
! .TP
! .B -p n
! Display the last n file path components instead of the default
! (1). Use 0 to not display the file name at all.
  .TP
  .B -q
--- 136,158 ----
  below).
  .TP
! .BI -[ "0-9" ] pattern
! Go to input field 
! .I num 
! (counting from 0) and find 
! .I pattern.
! .TP
! .BI -P path
! Prepend 
! .I path 
! to relative file names in a pre-built cross-reference file so you do
! not have to change to the directory where the cross-reference file was
! built. This option is only valid with the -d option.
! .TP
! .BI -p n
! Display the last
! .I n 
! file path components instead of the default (1). Use 
! .I 0 
! to not display the file name at all.
  .TP
  .B -q
***************
*** 132,140 ****
  .TP
  .B -R
! Recurse subdirectories for source files.
  .TP
! .B -s dir
! Look in dir for additional source files. This option is ignored
! if source files are given on the command line.
  .TP
  .B -T
--- 164,174 ----
  .TP
  .B -R
! Recurse subdirectories during search for source files.
  .TP
! .BI -s dir
! Look in
! .I dir
! for additional source files. This option is ignored if source files
! are given on the command line.
  .TP
  .B -T
***************
*** 156,161 ****
  database building and searches.
  .TP
! .B -V
! Print on the first line of screen the version number of cscope.
  .PP
  The -I, -c, -k, -p, -q, and -T options can also be in the cscope.files file.
--- 190,195 ----
  database building and searches.
  .TP
! .I files
! A list of file names to operate on.
  .PP
  The -I, -c, -k, -p, -q, and -T options can also be in the cscope.files file.