groff
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Modernising UNIX manpages.


From: JM Marcastel
Subject: Re: Modernising UNIX manpages.
Date: Thu, 22 Apr 2021 18:37:24 +0200


> On 22 Apr 2021, at 09:35, Marc Chantreux <eiro@phear.org> wrote:
> 
> There is no way you'll manage requests like .In, .Fn .Vt, .Ft, .Fn, .Op
> with commonmark.


Food for thought… though in my opinion the usage strings and the synopsis are 
like a table of contents, automatically generated.

How about:

#usage filter [-flag] <infile> <outfile>

In lieu of:

.Nm filter
.Op Fl flag
.Ao Ar infile Ac Ao Ar outfile Ac


Or:

#usage make [-eiknqrstv] [-D variable] [-d flags] [-f makefile] [-I directory] 
[-j max_jobs] [variable=value] [target ...]

In lieu of:

.Nm make
.Op Fl eiknqrstv
.Op Fl D Ar variable
.Op Fl d Ar flags
.Op Fl f Ar makefile
.Op Fl I Ar directory
.Op Fl j Ar max_jobs
.Op Ar variable Ns =Ns Ar value
.Bk
.Op Ar target ...
.Ek


And in pure Markdown with no customisation (and to be a little cheeky), how 
about

``` .c
int res_mkquery(int op, char *dname, int class, int type, char *data, int 
datalen, struct rrec *newrr, char *buf, int buflen)
```

In lieu of:

.Ft int
.Fo res_mkquery
.Fa "int op"
.Fa "char *dname"
.Fa "int class"
.Fa "int type"
.Fa "char *data"
.Fa "int datalen"
.Fa "struct rrec *newrr"
.Fa "char *buf"
.Fa "int buflen"
.Fc










reply via email to

[Prev in Thread] Current Thread [Next in Thread]