id          = "qman"
name        = "Qman"
homepage    = "https://github.com/plp13/qman"
description = "Modern man page viewer"
executables      = ["qman"]

[dotfiles]

# qman(1), https://manpages.ubuntu.com/manpages/stonking/man1/qman.1.html:
# the user file is ${XDG_CONFIG_HOME}/qman/qman.conf, normally ~/.config.
paths = ["[configHome]/qman/qman.conf"]
secret = []

[commands]
format = 1
label = "View a man page"
description = "Open a manual page in Qman, or search and list pages. Local-file mode, global apropos and action-on-startup are left out."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = false, short_attached = false, short_bundles = false }

[[commands.source]]
id = "man"
kind = "manual"
url = "https://manpages.ubuntu.com/manpages/stonking/man1/qman.1.html"
revision = "2026-10-27"
evidence = """
qman [options] [[section] page]
qman [options] -k regexp ...
qman [options] -f page ...
-n, --index  Show a list of all manual pages on the system, together with their sections and short descriptions.
-k, --apropos regexp  Interactive equivalent to apropos(1).
-f, --whatis page  Interactive equivalent to whatis(1).
-T, --cli  Suppress the text user interface and output directly to the terminal.
-C, --config-path file  Use file as the configuration file for Qman.
"""

[[commands.field]]
id = "page"
label = "Section and page"
description = "Optional section followed by the page name, for example 3 printf. Leave empty to list all pages."
type = "string"
position = 0
multiple = true
sources = ["man"]

[[commands.field]]
id = "apropos"
label = "Search names and descriptions"
description = "Regular expression, like apropos(1). Used instead of a page name."
type = "string"
option = ["--apropos", "-k"]
sources = ["man"]

[[commands.field]]
id = "whatis"
label = "Show short description of page"
type = "string"
option = ["--whatis", "-f"]
sources = ["man"]

[[commands.field]]
id = "index"
label = "List all pages"
type = "boolean"
option = ["--index", "-n"]
sources = ["man"]

[[commands.field]]
id = "cli"
label = "Plain output (no interface)"
description = "Print formatted output to the terminal instead of opening the text interface."
type = "boolean"
option = ["--cli", "-T"]
sources = ["man"]

[[commands.field]]
id = "config_path"
label = "Config file"
type = "path"
option = ["--config-path", "-C"]
path = { kind = "file", role = "input" }
sources = ["man"]

[[commands.task]]
id = "open_page"
label = "Open a page"
fields = ["page"]
required = ["page"]

[[commands.task]]
id = "search"
label = "Search pages"
fields = ["apropos"]
required = ["apropos"]

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["page", "apropos", "whatis", "index"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["cli", "config_path"]