spec

README

carapace-spec-man

Spec generation for manpages.

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.

Documentation

Index

• func Command(exe string, trimDescriptions bool) (*command.Command, error)

Functions

func Command

func Command(exe string, trimDescriptions bool) (*command.Command, error)