[gssapi-openssh.git] / openssh / 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],"^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
0fff78ff	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
c9f39d2c	35	breakw=0
0fff78ff	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))
cdd66111	80	add(OFS)
0fff78ff	81	} else if(match(words[w],"^Xc$")) {
	82	skip=1
	83	ext=0
	84	if(!extopt)
cdd66111	85	prenl++
0fff78ff	86	w=nwords
	87	} else if(match(words[w],"^Bd$")) {
	88	skip=1
	89	if(match(words[w+1],"-literal")) {
cdd66111	90	literal=1
	91	prenl++
	92	w=nwords
0fff78ff	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)
cdd66111	100	nospace=1
0fff78ff	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],"^[\\.,]"))
cdd66111	111	add(OFS words[++w])
0fff78ff	112	add("''")
0fff78ff	113	if(!nospace&&match(words[w+1],"^[\\.,]"))
cdd66111	114	nospace=1
0fff78ff	115	} else if(match(words[w],"^Sq\|Ql$")) {
	116	skip=1
	117	add("`" words[++w] "'")
	118	if(!nospace&&match(words[w+1],"^[\\.,]"))
cdd66111	119	nospace=1
0fff78ff	120	} else if(match(words[w],"^Oo$")) {
	121	skip=1
	122	extopt=1
	123	if(!nospace)
cdd66111	124	nospace=1
0fff78ff	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))
cdd66111	133	add(OFS)
0fff78ff	134	if(nospace==1)
cdd66111	135	nospace=0
0fff78ff	136	}
	137	if(match(words[w],"^Dd$")) {
	138	date=wtail()
	139	next
	140	} else if(match(words[w],"^Dt$")) {
	141	id=wtail()
	142	next
	143	} else if(match(words[w],"^Os$")) {
	144	add(".TH " id " \"" date "\" \"" wtail() "\"")
	145	} else if(match(words[w],"^Sh$")) {
	146	add(".SH")
	147	synopsis=match(words[w+1],"SYNOPSIS")
	148	} else if(match(words[w],"^Xr$")) {
	149	add("\\fB" words[++w] "\\fP(" words[++w] ")" words[++w])
	150	} else if(match(words[w],"^Rs$")) {
	151	split("",refauthors)
	152	nrefauthors=0
	153	reftitle=""
	154	refissue=""
	155	refdate=""
	156	refopt=""
	157	reference=1
	158	next
	159	} else if(match(words[w],"^Re$")) {
	160	prenl++
	161	for(i=nrefauthors-1;i>0;i--) {
cdd66111	162	add(refauthors[i])
	163	if(i>1)
	164	add(", ")
0fff78ff	165	}
0fff78ff	166	if(nrefauthors>1)
cdd66111	167	add(" and ")
0fff78ff	168	add(refauthors[0] ", \\fI" reftitle "\\fP")
0fff78ff	169	if(length(refissue))
cdd66111	170	add(", " refissue)
0fff78ff	171	if(length(refdate))
cdd66111	172	add(", " refdate)
0fff78ff	173	if(length(refopt))
cdd66111	174	add(", " refopt)
0fff78ff	175	add(".")
	176	reference=0
	177	} else if(reference) {
	178	if(match(words[w],"^%A$")) { refauthors[nrefauthors++]=wtail() }
	179	if(match(words[w],"^%T$")) {
cdd66111	180	reftitle=wtail()
	181	sub("^\"","",reftitle)
	182	sub("\"$","",reftitle)
0fff78ff	183	}
	184	if(match(words[w],"^%N$")) { refissue=wtail() }
	185	if(match(words[w],"^%D$")) { refdate=wtail() }
	186	if(match(words[w],"^%O$")) { refopt=wtail() }
	187	} else if(match(words[w],"^Nm$")) {
	188	if(synopsis) {
cdd66111	189	add(".br")
cdd66111	190	prenl++
0fff78ff	191	}
	192	n=words[++w]
	193	if(!length(name))
cdd66111	194	name=n
0fff78ff	195	if(!length(n))
cdd66111	196	n=name
0fff78ff	197	add("\\fB" n "\\fP")
0fff78ff	198	if(!nospace&&match(words[w+1],"^[\\.,]"))
cdd66111	199	nospace=1
0fff78ff	200	} else if(match(words[w],"^Nd$")) {
	201	add("\\- " wtail())
	202	} else if(match(words[w],"^Fl$")) {
	203	add("\\fB\\-" words[++w] "\\fP")
	204	if(!nospace&&match(words[w+1],"^[\\.,]"))
cdd66111	205	nospace=1
0fff78ff	206	} else if(match(words[w],"^Ar$")) {
	207	add("\\fI")
	208	if(w==nwords)
cdd66111	209	add("file ...\\fP")
0fff78ff	210	else {
cdd66111	211	add(words[++w] "\\fP")
	212	while(match(words[w+1],"^\\\|$"))
	213	add(OFS words[++w] " \\fI" words[++w] "\\fP")
0fff78ff	214	}
0fff78ff	215	if(!nospace&&match(words[w+1],"^[\\.,]"))
cdd66111	216	nospace=1
0fff78ff	217	} else if(match(words[w],"^Cm$")) {
	218	add("\\fB" words[++w] "\\fP")
	219	while(w<nwords&&match(words[w+1],"^[\\.,:;)]"))
cdd66111	220	add(words[++w])
0fff78ff	221	} else if(match(words[w],"^Op$")) {
	222	option=1
	223	if(!nospace)
cdd66111	224	nospace=1
0fff78ff	225	add("[")
	226	} else if(match(words[w],"^Pp$")) {
	227	prenl++
	228	} else if(match(words[w],"^An$")) {
	229	prenl++
	230	} else if(match(words[w],"^Ss$")) {
	231	add(".SS")
	232	} else if(match(words[w],"^Pa$")&&!option) {
	233	add("\\fI")
	234	w++
	235	if(match(words[w],"^\\."))
cdd66111	236	add("\\&")
0fff78ff	237	add(words[w] "\\fP")
0fff78ff	238	while(w<nwords&&match(words[w+1],"^[\\.,:;)]"))
cdd66111	239	add(words[++w])
0fff78ff	240	} else if(match(words[w],"^Dv$")) {
	241	add(".BR")
	242	} else if(match(words[w],"^Em\|Ev$")) {
	243	add(".IR")
	244	} else if(match(words[w],"^Pq$")) {
	245	add("(")
	246	nospace=1
	247	parens=1
	248	} else if(match(words[w],"^Aq$")) {
	249	add("<")
	250	nospace=1
	251	angles=1
	252	} else if(match(words[w],"^S[xy]$")) {
	253	add(".B " wtail())
	254	} else if(match(words[w],"^Ic$")) {
	255	plain=1
	256	add("\\fB")
	257	while(w<nwords) {
cdd66111	258	w++
	259	if(match(words[w],"^Op$")) {
	260	w++
	261	add("[")
	262	words[nwords]=words[nwords] "]"
	263	}
	264	if(match(words[w],"^Ar$")) {
	265	add("\\fI" words[++w] "\\fP")
	266	} else if(match(words[w],"^[\\.,]")) {
	267	sub(" $","",line)
	268	if(plain) {
	269	add("\\fP")
	270	plain=0
	271	}
	272	add(words[w])
	273	} else {
	274	if(!plain) {
	275	add("\\fB")
	276	plain=1
	277	}
	278	add(words[w])
	279	}
	280	if(!nospace)
	281	add(OFS)
0fff78ff	282	}
	283	sub(" $","",line)
	284	if(plain)
cdd66111	285	add("\\fP")
0fff78ff	286	} else if(match(words[w],"^Bl$")) {
	287	oldoptlist=optlist
	288	if(match(words[w+1],"-bullet"))
cdd66111	289	optlist=1
0fff78ff	290	else if(match(words[w+1],"-enum")) {
cdd66111	291	optlist=2
cdd66111	292	enum=0
0fff78ff	293	} else if(match(words[w+1],"-tag"))
cdd66111	294	optlist=3
0fff78ff	295	else if(match(words[w+1],"-item"))
cdd66111	296	optlist=4
0fff78ff	297	else if(match(words[w+1],"-bullet"))
cdd66111	298	optlist=1
0fff78ff	299	w=nwords
	300	} else if(match(words[w],"^El$")) {
	301	optlist=oldoptlist
c9f39d2c	302	} else if(match(words[w],"^Bk$")) {
	303	if(match(words[w+1],"-words")) {
	304	w++
	305	breakw=1
	306	}
	307	} else if(match(words[w],"^Ek$")) {
	308	breakw=0
0fff78ff	309	} else if(match(words[w],"^It$")&&optlist) {
0fff78ff	310	if(optlist==1)
cdd66111	311	add(".IP \\(bu")
0fff78ff	312	else if(optlist==2)
cdd66111	313	add(".IP " ++enum ".")
0fff78ff	314	else if(optlist==3) {
cdd66111	315	add(".TP")
cdd66111	316	prenl++
c9f39d2c	317	if(match(words[w+1],"^Pa$\|^Ev$")) {
cdd66111	318	add(".B")
	319	w++
	320	}
0fff78ff	321	} else if(optlist==4)
cdd66111	322	add(".IP")
0fff78ff	323	} else if(match(words[w],"^Sm$")) {
0fff78ff	324	if(match(words[w+1],"off"))
cdd66111	325	nospace=2
0fff78ff	326	else if(match(words[w+1],"on"))
cdd66111	327	nospace=0
0fff78ff	328	w++
	329	} else if(!skip) {
	330	add(words[w])
	331	}
	332	}
	333	if(match(line,"^\\.[^a-zA-Z]"))
	334	sub("^\\.","",line)
	335	if(parens)
	336	add(")")
	337	if(angles)
	338	add(">")
	339	if(option)
	340	add("]")
	341	if(ext&&!extopt&&!match(line," $"))
	342	add(OFS)
	343	if(!ext&&!extopt&&length(line)) {
	344	print line
	345	prenl=0
	346	line=""
	347	}
	348	}