File: formatman.man

package info (click to toggle)
scilab 2.6-4
  • links: PTS
  • area: non-free
  • in suites: woody
  • size: 54,632 kB
  • ctags: 40,267
  • sloc: ansic: 267,851; fortran: 166,549; sh: 10,005; makefile: 4,119; tcl: 1,070; cpp: 233; csh: 143; asm: 135; perl: 130; java: 39
file content (39 lines) | stat: -rw-r--r-- 971 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
.TH formatman 3 "january 2001" "Scilab Group" "Scilab Function"
.so ../sci.an
.SH NAME
formatman - formats all help files in a directory in ascii, text or html
.SH CALLING SEQUENCE
.nf
formatman(path [,to])
.fi
.SH PARAMETERS
.TP 10
path
: character string, giving the path of the directory
.TP
to 
: character string with possible values "ascii", "tex","html"
.SH DESCRIPTION
This function, not yet fully checked, formats all help files (*.man)
of a given directory written in a subset of TROFF (text formatting
language) to ascii tex or html
.LP
Known TROFF directives are .TH, .SH, .TP, .RS, .RE, .LP, .IG,
 .nf, .fi, .TS, .TE, .ft, .IP
.LP
Font handling like
.nf
\fV, \fR, \fB, \fP, \fI, \f(CR]
.fi
are ignored
.TP 10
ascii
mode generates a .cat file for each .man file and a whatis file
.TP
tex 
mode generates a .tex file for each .man file and a whatis.tex file
.TP
html 
mode generates a .html file for each .man file and a index.html file
.SH SEE ALSO
help, man