git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: pedantry: is there a standard for what should be in the SYNOPSIS?

From
Robert P. J. Day <rpjday@crashcourse.ca>
Date
Nov 21, 2017, 21:16 UTC
Message-ID
<alpine.LFD.2.21.1711211615510.25800@localhost.localdomain>
In-Reply-To
<20171121175436.GA27041@aiede.mtv.corp.google.com>
On Tue, 21 Nov 2017, Jonathan Nieder wrote:
Show 11 quoted lines
> Hi,
>
> Robert P. J. Day wrote:
>
> > following up on an earlier question of mine, is there a standard
> > for what options should be listed in either the SYNOPSIS or the
> > DESCRIPTION sections of a man page? i ask since i'm seeing some
> > definite inconsistency.
>
> No standard.  Seems worth starting a discussion on what you'd like
> the standard to be.
  so i'm in charge? awesome. you won't regret it. :-)
rday
-- 
========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================
Previous: Jonathan Nieder
Message 3 of 3 in “pedantry: is there a standard for what should be in the SYNOPSIS?”
  1. Robert P. J. DayNov 21, 2017
  2. Jonathan NiederNov 21, 2017
  3. Robert P. J. DayNov 21, 2017

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.