https://github.com/carapace-sh/carapace-spec-man

spec generation for manpages
https://github.com/carapace-sh/carapace-spec-man

carapace

Last synced: about 1 month ago
JSON representation

spec generation for manpages

• Host: GitHub
• URL: https://github.com/carapace-sh/carapace-spec-man
• Owner: carapace-sh
• License: mit
• Created: 2023-11-24T11:28:05.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2025-02-21T08:10:54.000Z (3 months ago)
• Last Synced: 2025-03-21T15:54:11.932Z (about 2 months ago)
• Topics: carapace
• Language: Go
• Homepage: https://carapace.sh
• Size: 119 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# carapace-spec-man

[Spec](https://github.com/carapace-sh/carapace-spec) generation for manpages.

```yaml

name: touch

description: change file timestamps

flags:

    --help: display this help and exit

    --time=: 'change the specified time: WORD is access, atime, or use: equivalent to -a WORD is modify or mtime: equivalent to -m'

    --version: output version information and exit

    -a: change only the access time

    -c, --no-create: do not create any files

    -d, --date=: parse STRING and use it instead of current time

    -f: (ignored)

    -h, --no-dereference: affect each symbolic link instead of any referenced file (useful only on systems that can change the timestamps of a symlink)

    -m: change only the modification time

    -r, --reference=: use this file's times instead of current time

    -t=: use [[CC]YY]MMDDhhmm[.ss] instead of current time

completion:

    flag:

        date:

            - $files

        reference:

            - $files

        t:

            - $files

        time:

            - $files

    positionalany:

        - $files

```

> [!IMPORTANT]

> Manpages are highly inconsistent so the results will contain errors.

> 

> Issues you will encounter:

> - parsing failing completely

> - parsing being stuck (`git` has this issue)

> - missing flags or subcommands

> - invalid subcommands (`-` in manpage name is assumed as subcommand delimiter)

> - description not truncated well

>

> It is recommended to prepare them manually for [carapace-parse] instead.

[carapace-parse]:https://github.com/carapace-sh/carapace-bin/tree/master/cmd/carapace-parse