Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / openssh / f92e063872ffc12fd82be7e344e8aeeeefd7a8ee / . / mdoc2man.awk
blob: 9d112676940e44bb588e1076a4a0a93c2d990ba7 [file] [log] [blame]
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]1#!/usr/bin/awk
2#
Darren Tucker0c0dc492007-06-05 20:01:16 +1000[diff] [blame]3# $Id: mdoc2man.awk,v 1.8 2007/06/05 10:01:16 dtucker Exp $
Darren Tucker51e5ab02007-06-05 19:16:59 +1000[diff] [blame]4#
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]5# Version history:
Darren Tucker51e5ab02007-06-05 19:16:59 +1000[diff] [blame]6# v4+ Adapted for OpenSSH Portable (see cvs Id and history)
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]7# v3, I put the program under a proper license
8# Dan Nelson <dnelson@allantgroup.com> added .An, .Aq and fixed a typo
9# v2, fixed to work on GNU awk --posix and MacOS X
10# v1, first attempt, didn't work on MacOS X
11#
12# Copyright (c) 2003 Peter Stuge <stuge-mdoc2man@cdy.org>
13#
14# Permission to use, copy, modify, and distribute this software for any
15# purpose with or without fee is hereby granted, provided that the above
16# copyright notice and this permission notice appear in all copies.
17#
18# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
19# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
20# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
21# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
22# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
23# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
24# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
25
26
27BEGIN {
28 optlist=0
29 oldoptlist=0
30 nospace=0
31 synopsis=0
32 reference=0
33 block=0
34 ext=0
35 extopt=0
36 literal=0
37 prenl=0
Darren Tuckerd062da52004-07-02 18:43:09 +1000[diff] [blame]38 breakw=0
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]39 line=""
40}
41
42function wtail() {
43 retval=""
44 while(w<nwords) {
45 if(length(retval))
46 retval=retval OFS
47 retval=retval words[++w]
48 }
49 return retval
50}
51
52function add(str) {
53 for(;prenl;prenl--)
54 line=line "\n"
55 line=line str
56}
57
58! /^\./ {
59 for(;prenl;prenl--)
60 print ""
61 print
62 if(literal)
63 print ".br"
64 next
65}
66
67/^\.\\"/ { next }
68
69{
70 option=0
71 parens=0
72 angles=0
73 sub("^\\.","")
74 nwords=split($0,words)
75 for(w=1;w<=nwords;w++) {
76 skip=0
77 if(match(words[w],"^Li|Pf$")) {
78 skip=1
79 } else if(match(words[w],"^Xo$")) {
80 skip=1
81 ext=1
82 if(length(line)&&!(match(line," $")||prenl))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]83 add(OFS)
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]84 } else if(match(words[w],"^Xc$")) {
85 skip=1
86 ext=0
87 if(!extopt)
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]88 prenl++
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]89 w=nwords
90 } else if(match(words[w],"^Bd$")) {
91 skip=1
92 if(match(words[w+1],"-literal")) {
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]93 literal=1
94 prenl++
95 w=nwords
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]96 }
97 } else if(match(words[w],"^Ed$")) {
98 skip=1
99 literal=0
100 } else if(match(words[w],"^Ns$")) {
101 skip=1
102 if(!nospace)
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]103 nospace=1
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]104 sub(" $","",line)
105 } else if(match(words[w],"^No$")) {
106 skip=1
107 sub(" $","",line)
108 add(words[++w])
109 } else if(match(words[w],"^Dq$")) {
110 skip=1
111 add("``")
112 add(words[++w])
113 while(w<nwords&&!match(words[w+1],"^[\\.,]"))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]114 add(OFS words[++w])
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]115 add("''")
116 if(!nospace&&match(words[w+1],"^[\\.,]"))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]117 nospace=1
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]118 } else if(match(words[w],"^Sq|Ql$")) {
119 skip=1
120 add("`" words[++w] "'")
121 if(!nospace&&match(words[w+1],"^[\\.,]"))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]122 nospace=1
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]123 } else if(match(words[w],"^Oo$")) {
124 skip=1
125 extopt=1
126 if(!nospace)
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]127 nospace=1
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]128 add("[")
129 } else if(match(words[w],"^Oc$")) {
130 skip=1
131 extopt=0
132 add("]")
133 }
134 if(!skip) {
135 if(!nospace&&length(line)&&!(match(line," $")||prenl))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]136 add(OFS)
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]137 if(nospace==1)
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]138 nospace=0
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]139 }
140 if(match(words[w],"^Dd$")) {
Darren Tucker88bca062007-06-05 19:30:47 +1000[diff] [blame]141 if(match(words[w+1],"^\\$Mdocdate:")) {
Darren Tucker51e5ab02007-06-05 19:16:59 +1000[diff] [blame]142 w++;
143 if(match(words[w+4],"^\\$$")) {
144 words[w+4] = ""
145 }
146 }
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]147 date=wtail()
148 next
149 } else if(match(words[w],"^Dt$")) {
150 id=wtail()
151 next
Darren Tuckerf5615962005-05-31 16:59:16 +1000[diff] [blame]152 } else if(match(words[w],"^Ox$")) {
153 add("OpenBSD")
154 skip=1
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]155 } else if(match(words[w],"^Os$")) {
156 add(".TH " id " \"" date "\" \"" wtail() "\"")
157 } else if(match(words[w],"^Sh$")) {
158 add(".SH")
159 synopsis=match(words[w+1],"SYNOPSIS")
160 } else if(match(words[w],"^Xr$")) {
161 add("\\fB" words[++w] "\\fP(" words[++w] ")" words[++w])
162 } else if(match(words[w],"^Rs$")) {
163 split("",refauthors)
164 nrefauthors=0
165 reftitle=""
166 refissue=""
167 refdate=""
168 refopt=""
Darren Tucker0c0dc492007-06-05 20:01:16 +1000[diff] [blame]169 refreport=""
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]170 reference=1
171 next
172 } else if(match(words[w],"^Re$")) {
173 prenl++
174 for(i=nrefauthors-1;i>0;i--) {
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]175 add(refauthors[i])
176 if(i>1)
177 add(", ")
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]178 }
179 if(nrefauthors>1)
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]180 add(" and ")
Darren Tucker0c0dc492007-06-05 20:01:16 +1000[diff] [blame]181 if(nrefauthors>0)
182 add(refauthors[0] ", ")
183 add("\\fI" reftitle "\\fP")
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]184 if(length(refissue))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]185 add(", " refissue)
Darren Tucker0c0dc492007-06-05 20:01:16 +1000[diff] [blame]186 if(length(refreport)) {
187 add(", " refreport)
188 }
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]189 if(length(refdate))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]190 add(", " refdate)
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]191 if(length(refopt))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]192 add(", " refopt)
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]193 add(".")
194 reference=0
195 } else if(reference) {
196 if(match(words[w],"^%A$")) { refauthors[nrefauthors++]=wtail() }
197 if(match(words[w],"^%T$")) {
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]198 reftitle=wtail()
199 sub("^\"","",reftitle)
200 sub("\"$","",reftitle)
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]201 }
202 if(match(words[w],"^%N$")) { refissue=wtail() }
203 if(match(words[w],"^%D$")) { refdate=wtail() }
204 if(match(words[w],"^%O$")) { refopt=wtail() }
Darren Tucker0c0dc492007-06-05 20:01:16 +1000[diff] [blame]205 if(match(words[w],"^%R$")) { refreport=wtail() }
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]206 } else if(match(words[w],"^Nm$")) {
207 if(synopsis) {
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]208 add(".br")
209 prenl++
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]210 }
211 n=words[++w]
212 if(!length(name))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]213 name=n
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]214 if(!length(n))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]215 n=name
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]216 add("\\fB" n "\\fP")
217 if(!nospace&&match(words[w+1],"^[\\.,]"))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]218 nospace=1
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]219 } else if(match(words[w],"^Nd$")) {
220 add("\\- " wtail())
221 } else if(match(words[w],"^Fl$")) {
222 add("\\fB\\-" words[++w] "\\fP")
223 if(!nospace&&match(words[w+1],"^[\\.,]"))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]224 nospace=1
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]225 } else if(match(words[w],"^Ar$")) {
226 add("\\fI")
227 if(w==nwords)
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]228 add("file ...\\fP")
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]229 else {
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]230 add(words[++w] "\\fP")
231 while(match(words[w+1],"^\\|$"))
232 add(OFS words[++w] " \\fI" words[++w] "\\fP")
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]233 }
234 if(!nospace&&match(words[w+1],"^[\\.,]"))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]235 nospace=1
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]236 } else if(match(words[w],"^Cm$")) {
237 add("\\fB" words[++w] "\\fP")
238 while(w<nwords&&match(words[w+1],"^[\\.,:;)]"))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]239 add(words[++w])
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]240 } else if(match(words[w],"^Op$")) {
241 option=1
242 if(!nospace)
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]243 nospace=1
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]244 add("[")
245 } else if(match(words[w],"^Pp$")) {
246 prenl++
247 } else if(match(words[w],"^An$")) {
248 prenl++
249 } else if(match(words[w],"^Ss$")) {
250 add(".SS")
251 } else if(match(words[w],"^Pa$")&&!option) {
252 add("\\fI")
253 w++
254 if(match(words[w],"^\\."))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]255 add("\\&")
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]256 add(words[w] "\\fP")
257 while(w<nwords&&match(words[w+1],"^[\\.,:;)]"))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]258 add(words[++w])
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]259 } else if(match(words[w],"^Dv$")) {
260 add(".BR")
261 } else if(match(words[w],"^Em|Ev$")) {
262 add(".IR")
263 } else if(match(words[w],"^Pq$")) {
264 add("(")
265 nospace=1
266 parens=1
267 } else if(match(words[w],"^Aq$")) {
268 add("<")
269 nospace=1
270 angles=1
271 } else if(match(words[w],"^S[xy]$")) {
272 add(".B " wtail())
273 } else if(match(words[w],"^Ic$")) {
274 plain=1
275 add("\\fB")
276 while(w<nwords) {
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]277 w++
278 if(match(words[w],"^Op$")) {
279 w++
280 add("[")
281 words[nwords]=words[nwords] "]"
282 }
283 if(match(words[w],"^Ar$")) {
284 add("\\fI" words[++w] "\\fP")
285 } else if(match(words[w],"^[\\.,]")) {
286 sub(" $","",line)
287 if(plain) {
288 add("\\fP")
289 plain=0
290 }
291 add(words[w])
292 } else {
293 if(!plain) {
294 add("\\fB")
295 plain=1
296 }
297 add(words[w])
298 }
299 if(!nospace)
300 add(OFS)
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]301 }
302 sub(" $","",line)
303 if(plain)
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]304 add("\\fP")
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]305 } else if(match(words[w],"^Bl$")) {
306 oldoptlist=optlist
307 if(match(words[w+1],"-bullet"))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]308 optlist=1
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]309 else if(match(words[w+1],"-enum")) {
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]310 optlist=2
311 enum=0
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]312 } else if(match(words[w+1],"-tag"))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]313 optlist=3
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]314 else if(match(words[w+1],"-item"))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]315 optlist=4
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]316 else if(match(words[w+1],"-bullet"))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]317 optlist=1
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]318 w=nwords
319 } else if(match(words[w],"^El$")) {
320 optlist=oldoptlist
Darren Tuckerd062da52004-07-02 18:43:09 +1000[diff] [blame]321 } else if(match(words[w],"^Bk$")) {
322 if(match(words[w+1],"-words")) {
323 w++
324 breakw=1
325 }
326 } else if(match(words[w],"^Ek$")) {
327 breakw=0
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]328 } else if(match(words[w],"^It$")&&optlist) {
329 if(optlist==1)
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]330 add(".IP \\(bu")
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]331 else if(optlist==2)
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]332 add(".IP " ++enum ".")
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]333 else if(optlist==3) {
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]334 add(".TP")
335 prenl++
Darren Tucker58cef1f2004-06-28 15:45:08 +1000[diff] [blame]336 if(match(words[w+1],"^Pa$|^Ev$")) {
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]337 add(".B")
338 w++
339 }
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]340 } else if(optlist==4)
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]341 add(".IP")
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]342 } else if(match(words[w],"^Sm$")) {
343 if(match(words[w+1],"off"))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]344 nospace=2
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]345 else if(match(words[w+1],"on"))
Damien Millera8e06ce2003-11-21 23:48:55 +1100[diff] [blame]346 nospace=0
Darren Tucker167bd9c2003-09-07 12:34:54 +1000[diff] [blame]347 w++
348 } else if(!skip) {
349 add(words[w])
350 }
351 }
352 if(match(line,"^\\.[^a-zA-Z]"))
353 sub("^\\.","",line)
354 if(parens)
355 add(")")
356 if(angles)
357 add(">")
358 if(option)
359 add("]")
360 if(ext&&!extopt&&!match(line," $"))
361 add(OFS)
362 if(!ext&&!extopt&&length(line)) {
363 print line
364 prenl=0
365 line=""
366 }
367}