Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Change option description string #1151

Merged
merged 1 commit into from
Mar 14, 2023
Merged

Change option description string #1151

merged 1 commit into from
Mar 14, 2023

Conversation

NolanDeveloper
Copy link
Contributor

It took very long time for me to figure out what is that "summary" dunstify says it needs.

$ dunstify
I need at least a summary
$ dunstify --help
Usage:
  dunstify [OPTION…] - Dunstify

Help Options:
  -?, --help                  Show help options

Application Options:
  -a, --appname=NAME          Name of your application
  -u, --urgency=URG           The urgency of this notification
  -h, --hints=HINT            User specified hints
  -A, --action=ACTION         Actions the user can invoke
  -t, --timeout=TIMEOUT       The time in milliseconds until the notification expires
  -i, --icon=ICON             An Icon that should be displayed with the notification
  -I, --raw_icon=RAW_ICON     Path to the icon to be sent as raw image data
  -c, --capabilities          Print the server capabilities and exit
  -s, --serverinfo            Print server information and exit
  -p, --printid               Print id, which can be used to update/replace this notification
  -r, --replace=ID            Set id of this notification.
  -C, --close=ID              Close the notification with the specified ID
  -b, --block                 Block until notification is closed and print close reason

Now I understand "- Dunstify" is an example of usage. It wasn't so obvious for me though. Typical error says about some "summary" which I don't see in the --help output. This patch would change --help output to mention this word and eliminate possible confusion.

$ dunstify
I need at least a summary
$ dunstify --help
Usage:
  dunstify [OPTION…] SUMMARY BODY
  ...

@fwsmit fwsmit merged commit fdf7927 into dunst-project:master Mar 14, 2023
@fwsmit
Copy link
Member

fwsmit commented Mar 14, 2023

Thanks, this was very unclear indeed

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

Successfully merging this pull request may close these issues.

2 participants