GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  DOCTEXT (1)

NAME

doctext - Generate documentation pages from source files

CONTENTS

Synopsis
Input Parameters
Location

SYNOPSIS

doctext [ -mpath path ] [ -ext n ] [ -I filename ] [ -latex ]
[ -html ] [ -index filename ] [ -indexdir filename ]
[ -jumpfile filename ] [ -outfile filename ]
[ -mapref filename ] [ -nolocation ] [ -location ]
[ -defn defnfile ] [ -dosnl ] [ -skipprefix name ]
[ -ignore string ]
[ -heading string ] [ -basedir dirname ] filenames

INPUT PARAMETERS

-mpath path
  - Sets the path where the man pages will be written
-ext n
  - Sets the extension (1-9,l, etc)
-nolocation
  - Don’t give the filename where the man page info was
-I filename
  - Filename contains the public includes needed by these routines
-latex
  - Generate latex output rather than man format files
-html
  - Generate html (WWW) output rather than man format files
-index filename
  - Generate a index file appropriate for tohtml (for generating WWW files)
-defn defnfilename
  - Read commands from this file after loading the default commands
-mapref filename
  - Read hyperlink database and apply to output
-indexdir dirname
  - Sets the root directory for the index file entries. For example
-index foo.cit -indexdir \"http://www.mcs.anl.gov/foo/man\"
-outfile filename
  - Put the manpages in the indicated file
-heading name
  - Name for the heading (middle of top line)
-quotefmt
  - support ’\\tt’ and ‘\\em‘
-skipprefix name
  - skip ’name’ at the beginning of each line. This may be used for Fortran or Shell sources
-ignore string
  - skip ’name’ in a function synopsis. This can be used to remove special keywords needed to build the routine but not needed by the user (e.g., special export keywords when building DLLs)
-keyword filename
  - Place keyword entries at the end of the specified file
-locdir directory
  - Uses directory in the Location: field
-dosnl
  - Generate DOS style files (return-newline instead of newline)
filenames
  - Names of the files from which documents are to be extracted

LOCATION

doctext.cc
Search for    or go to Top of page |  Section 1 |  Main Index


DOCTEXT (1) 2/1/2000

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.