Feature Request: Man pages

All your suggestions, requests and ideas for future development
Post Reply
bb1netusaf2004
Posts: 3
Joined: 15 Jan 2022, 22:17

Feature Request: Man pages

Post by bb1netusaf2004 »

I've recently been using the CLI and having the man pages so you can run `man filebot` would be amazing.
User avatar
rednoah
The Source
Posts: 20837
Joined: 16 Nov 2011, 08:59

Re: Feature Request: Man pages

Post by rednoah »

man pages are somewhat ill-suited for filebot because the documentation has evolved with links and dedicated pages with details and examples for each option:
https://www.filebot.net/cli.html


:idea: We could add a man page, but it would really only be a copy of filebot -help because if we were to maintain a dedicated CLI man page, in addition to the public HTML page, then the CLI man page (with few users to use or maintain it) would likely be outdated and erroneous before too long.


:!: Notably, even among the dedicated Linux packages most of them (i.e. portable, snap, flatpack, qpkg, spk, docker, etc) wouldn't be able to install man pages onto the system.


:arrow: bash auto-completion might help with quickly checking for available options at the very least:
https://github.com/filebot/plugins/blob ... .d/filebot
:idea: Please read the FAQ and How to Request Help.
bb1netusaf2004
Posts: 3
Joined: 15 Jan 2022, 22:17

Re: Feature Request: Man pages

Post by bb1netusaf2004 »

Oh nice, I was trying to use `--help` and `-h` (much more common in the non-java linux world than a single dash option) and it just dropped a link to the online man pages. `-help` I think is sufficient. Also thanks for the link to bash completion, that's great!

I think I would change this feature request to be "alias -help to --help and -h"
User avatar
rednoah
The Source
Posts: 20837
Joined: 16 Nov 2011, 08:59

Re: Feature Request: Man pages

Post by rednoah »

bb1netusaf2004 wrote: 16 Jan 2022, 18:40 Also thanks for the link to bash completion, that's great!
What OS are you using? How did you install FileBot? The native packages (e.g. deb and rpm) should install bash auto-complete support by copying plugins/completion/bash_completion.d/filebot into /etc/bash_completion.d/filebot on install, so it should work by default.
:idea: Please read the FAQ and How to Request Help.
Post Reply