[openssh.git] / mdoc2man.awk

#!/usr/bin/awk
#
# Version history:
#  v3, I put the program under a proper license
#      Dan Nelson <dnelson@allantgroup.com> added .An, .Aq and fixed a typo
#  v2, fixed to work on GNU awk --posix and MacOS X
#  v1, first attempt, didn't work on MacOS X
#
# Copyright (c) 2003 Peter Stuge <stuge-mdoc2man@cdy.org>
#
# Permission to use, copy, modify, and distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.


BEGIN {
  optlist=0
  oldoptlist=0
  nospace=0
  synopsis=0
  reference=0
  block=0
  ext=0
  extopt=0
  literal=0
  prenl=0
  breakw=0
  line=""
}

function wtail() {
  retval=""
  while(w<nwords) {
    if(length(retval))
      retval=retval OFS
    retval=retval words[++w]
  }
  return retval
}

function add(str) {
  for(;prenl;prenl--)
    line=line "\n"
  line=line str
}

! /^\./ {
  for(;prenl;prenl--)
    print ""
  print
  if(literal)
    print ".br"
  next
}

/^\.\\"/ { next }

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