diff options
Diffstat (limited to 'contrib/ntp/sntp/ag-tpl/0-old/mdoc-synopsis.tlib')
-rw-r--r-- | contrib/ntp/sntp/ag-tpl/0-old/mdoc-synopsis.tlib | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/contrib/ntp/sntp/ag-tpl/0-old/mdoc-synopsis.tlib b/contrib/ntp/sntp/ag-tpl/0-old/mdoc-synopsis.tlib new file mode 100644 index 0000000..35fe05b --- /dev/null +++ b/contrib/ntp/sntp/ag-tpl/0-old/mdoc-synopsis.tlib @@ -0,0 +1,92 @@ +[+: autogen5 template man :+][+: +DEFINE mk-synopsis :+][+: + (out-push-new file-name) \:+] +.Sh SYNOPSIS +.Nm[+: + + IF (. use-flags) :+][+: + IF (exist? "long-opts") :+] +.\" Mixture of short (flag) options and long options +.Op Fl flags +.Op Fl flag Op Ar value +.Op Fl \-option-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc +[+: ELSE no long options: :+] +.Op Fl flags +.Op Fl flag Op Ar value +[+: ENDIF + :+][+: + ELIF (exist? "long-opts") + :+] +.Op Fl \-option-name +.Op Fl \-option-name Ar value +[+: + + ELIF (not (exist? "argument")) :+] +.Op Ar option\-name Ar value +.Pp +All arguments are named options. +[+: + ENDIF :+][+: + + IF (exist? "argument") :+][+: + argument :+][+: + + IF (exist? "reorder-args") :+] +.Pp +Operands and options may be intermixed. They will be reordered. +[+: ENDIF :+][+: + + ELIF (or (exist? "long-opts") use-flags) + +:+] +.Pp +All arguments must be options. +[+: + + ENDIF :+][+: + + IF (exist? "main") :+][+: + CASE main.main-type :+][+: + == shell-process :+] +.Pp +This program will emit text that is expected to be evaluated by +a Bourne-compatible shell, thus digesting the options for the script.[+: + + == shell-parser :+] +.Pp +This program is designed to produce output suitable for inclusion +into a shell script that will parse the options described.[+: + + == for-each :+] +.Pp +The operands that this program operates on may be specified either +on the command line or read from standard input, one per line. +In that input, leading and trailing white space is stripped, +blank lines are ignored[+: + + IF (define comment-char (get "comment-char" "#")) + (> (string-length comment-char) 1) \:+] + and lines beginning with the character +.I [+: (substring comment-char 1 0):+] +are treated as comments[+: + ENDIF :+].[+: + + IF (exist? "interleaved") :+] +Options may be interleaved with operands both on the command +line and when operands are read from standard input.[+: + ENDIF interleaved + +:+] +Standard input may not be a terminal.[+: + + ESAC main-type :+][+: + ENDIF main exists :+] +.Pp +[+: + +FOR explain "\n.Pp\n" :+][+: + (get "explain" "") :+][+: +ENDFOR :+][+: + +(out-pop) :+][+: +ENDDEF mk-synopsis :+] |