man pages: missing synopsis section

[mr-c]

Here we have the actual command and a brief listing of all options and positional parameters.

For subcommands there will be the space, unlike the manual page NAME section as shown in #154

example from git grep

GIT-GREP(1)                                                                    Git Manual                                                                    GIT-GREP(1)

NAME
       git-grep - Print lines matching a pattern

SYNOPSIS
       git grep [-a | --text] [-I] [--textconv] [-i | --ignore-case] [-w | --word-regexp]
                  [-v | --invert-match] [-h|-H] [--full-name]
                  [-E | --extended-regexp] [-G | --basic-regexp]
                  [-P | --perl-regexp]
                  [-F | --fixed-strings] [-n | --line-number] [--column]
                  [-l | --files-with-matches] [-L | --files-without-match]
                  [(-O | --open-files-in-pager) [<pager>]]
                  [-z | --null]
                  [ -o | --only-matching ] [-c | --count] [--all-match] [-q | --quiet]
                  [--max-depth <depth>] [--[no-]recursive]
                  [--color[=<when>] | --no-color]
                  [--break] [--heading] [-p | --show-function]
                  [-A <post-context>] [-B <pre-context>] [-C <context>]
                  [-W | --function-context]
                  [--threads <num>]
                  [-f <file>] [-e] <pattern>
                  [--and|--or|--not|(|)|-e <pattern>...]
                  [--recurse-submodules] [--parent-basename <basename>]
                  [ [--[no-]exclude-standard] [--cached | --no-index | --untracked] | <tree>...]
                  [--] [<pathspec>...]

[eseiler]

Core Meeting 24/10/2022

• Currently, the synopsis has to be provided by the app developer.
• Check whether this can be autogenerated.

[smehringer]

A simple automated synopsis could be:

no positional options

app-name [options]

with two positional options, a path and a number

app-name [options] [--] <PATH> <NUMBER>

[eseiler]

Maybe I'll work on a simple version. I noticed that it is very easy to forget updating the synopsis when you change something in the argument parsing.