File: testpage.1

package info (click to toggle)
roffit 0.7~20120815+gitbbf62e6-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, jessie, jessie-kfreebsd, sid, stretch
  • size: 116 kB
  • ctags: 7
  • sloc: perl: 370; makefile: 14
file content (67 lines) | stat: -rw-r--r-- 2,462 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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
.\" This man page is here for testing purposes only. Run 'make test' to
.\" verify that the correct output is generated from this input.
.\"
.TH testpage 1 "2 May 2011" "roffit" "roffit test"
.SH NAME
testpage \- test input nroff man page for roffit testing
.SH SYNOPSIS
.B roffit [options] < inputfile > outputfile
.SH DESCRIPTION
.B roffit
converts the \fIinputfile\fP to \fIoutputfile\fP. The \fIinputfile\fP must be
an nroff formatted man page, and the \fIoutputfile\fP will be an HTML
document.

RFC 959 is FTP

RFC3986 is URI syntax

Also, we must support \fIstyle staring on one line
and ending on another
that may\fP be multiple lines off.
.SH OPTIONS
.IP "--bare"
The output HTML will not include any HTML, HEAD or BODY tags. Also not that
when this is selected, there will be no inlined CSS but you will have to
define the necessary classes yourself.
.IP "--mumbo"
Display version number and exit. Also see \fB--jumbo\fP. Word in bold.
.IP "--jumbo"
Cool option. See \fI--mumbo\fP. Word in italic.
.IP \-\-mandir=<dir>
Set a directory in which \fIroffit\fP will check for other man pages (in nroff
[name].[num] format) that this one refers to. If found, a <a href> link will
be made to that page with a html extension instead of the number. The file
name in the generated link will be prefixed by the dir given with
\fI\-\-hrefdir\fP.

This works for references specified as \fImanpage(3)\fP (within the emhpasis
foformatting) and in a plain \.BR section (often used in the SEE ALSO
section).
.IP \-\-hrefdir=<dir>
Specify a directory to prefix generated href links created with the \-\-mandir
option. This defaults to ".".
.SH "CSS CLASSES"
.IP h2.nroffsh
The nroff ".SH" section. These are normally the "headlines" before each sub
section within the man page.
.IP p.nroffip
The nroff ".IP" section. These are normally the bullet kind used to list each
option out of several in a list. Usually followed by a \fIp.level0\fP
containining the descriptive text.
.IP p.level0
Normal text at the first level. Normally not indented.
.IP p.level1
Text at next logical indent level. Normally indented one level right.
.IP p.level2
Text at the second logical indent level. Normally indented two levels right.
.IP span.bold
Text marked to be bold.
.IP span.manpage
Text marked as a reference to another man page.
.IP span.emphasis
Text marked to be emphasized.
.IP p.roffit
Used for the advertising final paragraph.
.SH WWW
http://daniel.haxx.se/projects/roffit