Penguin
Recent Changes
Blame: groff_mwww(7)
EditPageHistoryDiffInfoLikePages
Annotated edit history of groff_mwww(7) version 1, including all changes. View license author blame.
Rev Author # Line
1 perry 1 GROFF_MWWW
2 !!!GROFF_MWWW
3 ----
4 NAME
5 SYNOPSIS
6 DESCRIPTION
7 SYNPOSIS
8 REQUESTS
9 SECTION HEADING LINKS
10 LIMITATIONS OF GROHTML
11 FILES
12 SEE ALSO
13 AUTHOR
14 BUGS
15 !!NAME
16
17
18 groff_mwww - groff macros for authoring web pages
19 ----
20 !!SYNOPSIS
21
22
23 __groff -mwww__ [[ options ] file ...
24 !!DESCRIPTION
25
26
27 This manual page describes the GNU -mwww macros, which is
28 part of the groff document formatting system. The manual
29 page is very a basic guide, and the html device driver
30 (__grohtml__) has been completely rewritten but still
31 remains as in an alpha state. It has been included into the
32 distribution so that a lot of people have a chance to test
33 it. Note that this macro file will be automatically called
34 (via the troffrc file) if you use
35 -Thtml.
36
37
38 To see the hyperlinks in action, please format this man page
39 with the __grohtml__ device.
40
41
42 Here is a summary of the functions found in this macro
43 set.
44 !!SYNPOSIS
45
46
47 .HTMLINDEX determine automatic link cut off
48 point for sections/headers
49 .BODYCOLOR specify colours on a web page
50 .BACKGROUND specify background image
51 .URL create a url using two parameters
52 .MAILTO create a html email address
53 .FTP create an ftp reference
54 .IMAGE include an image file
55 .HTML pass an html raw request to the
56 device driver
57 .TAG generate an html name tag from $1
58 .LINE create a full width horizontal rule
59
60
61 Output of the ''pic'', ''eqn'', ''refer'', and
62 ''tbl'' preprocessors is acceptable as
63 input.
64 !!REQUESTS
65
66
67 __HTMLINDEX__
68
69
70 determines the cut off point for automatic link generation
71 to headings. By default all headings found in a troff
72 document have links created to them at the top of the html
73 web page. It maybe that many of the lower heading levels do
74 not require links. Alternatively some web pages may not need
75 any heading links at all, in which case:
76
77
78 .HTMLINDEX 0
79 will tell __grohtml__ not to generate links. An HTMLINDEX of 2 will mean that a heading
80
81
82 __1.1.1 Some Title__
83
84
85 will not be included in the links either as it is said to
86 have a heading level of three. Another method for switching
87 automatic headings is via the command line switch
88 -P-l.
89
90
91 __BODYCOLOR__
92
93
94 takes five parameters: foreground, background, active
95 hypertext link, hypertext link not yet visited, and visited
96 hypertext link colour.
97
98
99 __BACKGROUND__
100
101
102 the only parameter to this macro is the background image
103 file.
104
105
106 __URL__
107
108
109 generates a URL using either two or three
110 arguments. $1 is the name of the link, $2 is the actual URL,
111 and $3 is optional stuff to be printed immediately after $2.
112 Hyphenation is disabled while printing the actual URL;
113 explicit breakpoints should be inserted with the __:__
114 escape. Here is how to encode
115 homepage for groff:
116
117
118 .URL
119 If this is processed by a device other than -Thtml it appears as: homepage for groff http://groff. ffii.org. The URL macro can be of any type; for example we can reference Eric Raymond's pic guide by:
120
121
122 .URL
123
124
125 __MAILTO__
126
127
128 generates an email html reference. The first argument is
129 mandatory as the email address. The optional second argument
130 is the text you see in your browser, and an optional third
131 argument is stuff printed immediately after the second
132 argument. Hyphenation is disabled while printing the actual
133 email address. For example, the groff maintainers are
134 Werner Lemberg and
135 Ted Harding.
136 This is achieved by the following macros:
137
138
139 .MAILTO wl@gnu.org
140 Note that all the urls actually are treated as consuming no textual space in groff. This could be considered as a bug since it causes some problems. To circumvent this, www.tmac inserts a zero-width character which expands to a harmless space (only if run with -Thtml).
141
142
143 __FTP__
144
145
146 indicates that data can be obtained via ftp. The first
147 argument is the browser text and the second is the url. A
148 third argument, similar to the macros above, is intended for
149 stuff printed immediately after the second argument. The
150 second and the third parameter are optional. Hyphenation is
151 disabled while printing the actual URL. As an example, here
152 the location of the
153 current groff development distribution.
154 The macro example above was specified by:
155
156
157 .FTP
158
159
160 __IMAGE__
161
162
163 allows the document to include pictures. The first argument
164 is the image file. The second optional argument gives the
165 horizontal location; __l__ puts the image to the left
166 border, __r__ to the right. Any other value centers the
167 image. The next two arguments are optional also: Argument
168 three is the width in pixels (default is 400 pixels if
169 absent). The fourth argument is the height in pixels
170 (default is the width value if absent).
171
172
173 __HTML__
174
175
176 all text after this macro is treated as raw html. If the
177 document is processed ''without'' -Thtml then
178 the macro is ignored. This macro is a building block for
179 other higher level macros.
180
181
182 For example, the BACKGROUND macro is defined
183 as:
184
185
186 .de BACKGROUND
187 . HTML
188
189
190 __TAG__
191
192
193 generates an html name tag from its argument. This can then
194 be referenced using the URL macro. As you
195 can see, you must precede the tag name with `#'
196 since it is a local reference. This link was achieved via
197 placing a TAG in the URL description above; the source looks
198 like this:
199
200
201 .TP
202 .B URL
203 generates
204 .TAG URL
205 a URL using either two or three
206 arguments.
207 $1 is the name of the link, $2 is the actual URL.
208
209
210 __LINE__
211
212
213 generates a full width horizontal rule.
214 Example:
215
216
217 .LINE
218
219
220 __LINKS__
221
222
223 requests that grohtml place the
224 automatically generated links at this position. For
225 example:
226 NAME
227 SYNOPSIS
228 DESCRIPTION
229 SYNPOSIS
230 REQUESTS
231 SECTION HEADING LINKS
232 LIMITATIONS OF GROHTML
233 FILES
234 SEE ALSO
235 AUTHOR
236 BUGS
237 !!SECTION HEADING LINKS
238
239
240 By default __grohtml__ generates links to all section
241 headings and places these at the top of the html document.
242 (See LINKS for details of how to switch
243 this off or alter the position.
244 !!LIMITATIONS OF GROHTML
245
246
247 Tbl information is currently rendered as a png
248 image.
249 !!FILES
250
251
252 /usr/share/groff/1.17.2/tmac/mwww.tmac (a wrapper for
253 www.tmac)
254 /usr/share/groff/1.17.2/tmac/www.tmac
255 !!SEE ALSO
256
257
258 groff(1), troff(1)
259 grohtml(1),
260 !!AUTHOR
261
262
263 __Grohtml__ was written by
264 Gaius Mulley
265 !!BUGS
266
267
268 Report bugs to the
269 Groff Bug Mailing List.
270 Include a complete, self-contained example that will allow
271 the bug to be reproduced, and say which version of groff you
272 are using.
273 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.