Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Program description #381

Open
suntong opened this issue Jan 17, 2022 · 0 comments
Open

Program description #381

suntong opened this issue Jan 17, 2022 · 0 comments

Comments

@suntong
Copy link

suntong commented Jan 17, 2022

I've glimpsed through the help doc and it seems that there is no way to provide "program description", i.e., what the program is, what it does etc in the output help.

E.g., when you run rsync -h, before showing the usage, it first explains what it does:

rsync is a file transfer program capable of efficient remote update
via a fast differencing algorithm.

Usage: rsync [OPTION]... SRC [SRC]... DEST
  or   rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST
  or   rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST

IMHO, this is necessary for every program.

Please consider adding it.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant