After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 711396 - missing documentation about --notification --listen
missing documentation about --notification --listen
Status: RESOLVED FIXED
Product: zenity
Classification: Core
Component: docs
3.8.x
Other All
: Normal normal
: ---
Assigned To: Sindhu S
Zenity Maintainers
Depends on:
Blocks:
 
 
Reported: 2013-11-04 11:53 UTC by simohe
Modified: 2014-04-26 14:42 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Add user help for --listen bug 711396 (2.36 KB, patch)
2013-11-05 16:09 UTC, Sindhu S
needs-work Details | Review
Add user help for --listen bug 711396 (29.47 KB, patch)
2013-11-28 21:02 UTC, Sindhu S
none Details | Review
help: Update notifications.page (106.40 KB, patch)
2014-04-22 17:19 UTC, Sindhu S
none Details | Review

Description simohe 2013-11-04 11:53:38 UTC
The manual page does list the option --listen (for --notification), but not the commands valid on stdin.

The gnome documentation does not even list the option --listen:
 https://help.gnome.org/users/zenity/3.8/notification.html.de
(and also not the commands of course)

The commands on stdin for "zenity --notification --listen" are:
  icon: <name|path>
  message: <text>
  tooltip: <text>
  visible: <true|false>
(according to http://muzso.hu/2009/05/26/zenity-gtk-dialogs-for-shell-scripts)
Comment 1 Sindhu S 2013-11-05 15:31:11 UTC
Hi!

(In reply to comment #0)
> The manual page does list the option --listen (for --notification), but not the
> commands valid on stdin.

What do you mean by this? I can see that the man page for zenity says..

--listen
              Listen  for commands on stdin. Commands include 'message',
              'tooltip', 'icon', and 'visible' separated by a colon. For
              example,  'message:  Hello  world',  'visible:  false', or
              'icon: /path/to/icon'. The icon command also  accepts  the
              four  stock  icon: 'error', 'info', 'question', and 'warn‐
              ing'

To me this is clear about the usage of the --listen option.
 
> The gnome documentation does not even list the option --listen:
>  https://help.gnome.org/users/zenity/3.8/notification.html.de
> (and also not the commands of course)

Indeed that's because the mallard based help pages do not have any documentation on --listen. This is one issue and will require a patch to be filed. 

> The commands on stdin for "zenity --notification --listen" are:
>   icon: <name|path>
>   message: <text>
>   tooltip: <text>
>   visible: <true|false>
> (according to http://muzso.hu/2009/05/26/zenity-gtk-dialogs-for-shell-scripts)

Thank you for this bug report, I will file a patch soon.
Comment 2 Sindhu S 2013-11-05 16:09:12 UTC
Created attachment 259023 [details] [review]
Add user help for --listen bug 711396
Comment 3 simohe 2013-11-06 17:34:32 UTC
(In reply to comment #1)
> Hi!
> 
> (In reply to comment #0)
> > The manual page does list the option --listen (for --notification), but not the
> > commands valid on stdin.
> 
> What do you mean by this? I can see that the man page for zenity says..
> 
> --listen
>               Listen  for commands on stdin. Commands include 'message',
>               'tooltip', 'icon', and 'visible' separated by a colon. For
>               example,  'message:  Hello  world',  'visible:  false', or
>               'icon: /path/to/icon'. The icon command also  accepts  the
>               four  stock  icon: 'error', 'info', 'question', and 'warn‐
>               ing'
> 
> To me this is clear about the usage of the --listen option.

Agree. My local installation is older and the man pages I found on the internet did not show this as well.

> 
> > The gnome documentation does not even list the option --listen:
> >  https://help.gnome.org/users/zenity/3.8/notification.html.de
> > (and also not the commands of course)
> 
> Indeed that's because the mallard based help pages do not have any
> documentation on --listen. This is one issue and will require a patch to be
> filed. 
> 
> > The commands on stdin for "zenity --notification --listen" are:
> >   icon: <name|path>
> >   message: <text>
> >   tooltip: <text>
> >   visible: <true|false>
> > (according to http://muzso.hu/2009/05/26/zenity-gtk-dialogs-for-shell-scripts)
> 
> Thank you for this bug report, I will file a patch soon.

Thanks a lot.
Comment 4 Arx Cruz 2013-11-23 22:55:32 UTC
Review of attachment 259023 [details] [review]:

I wasn't able to apply the patch:

Applying: Add user help for --listen, bug 711396
error: cannot apply binary patch to 'help/C/figures/zenity-notification-listen-screenshot.png' without full index line
error: help/C/figures/zenity-notification-listen-screenshot.png: patch does not apply

Can you check and resend the patch?
Comment 5 Arx Cruz 2013-11-23 22:55:33 UTC
Review of attachment 259023 [details] [review]:

I wasn't able to apply the patch:

Applying: Add user help for --listen, bug 711396
error: cannot apply binary patch to 'help/C/figures/zenity-notification-listen-screenshot.png' without full index line
error: help/C/figures/zenity-notification-listen-screenshot.png: patch does not apply

Can you check and resend the patch?
Comment 6 Sindhu S 2013-11-24 06:36:26 UTC
Thank you for the review, I will fix the patch and reupload again. Sorry about the inconvinience.
Comment 7 Sindhu S 2013-11-28 21:02:35 UTC
Created attachment 263078 [details] [review]
Add user help for --listen bug 711396

Fixed patch.
Comment 8 Arx Cruz 2014-04-18 20:46:32 UTC
Hello,

Sorry for waste your time... I tried to apply your last patch and got this error:

git am 0001-Add-user-help-for-listen-bug-711396.patch
Applying: Add user help for --listen, bug 711396
error: help/C/figures/zenity-notification-listen-screenshot.png: already exists in index
error: patch failed: help/C/notification.page:16
error: help/C/notification.page: patch does not apply
Patch failed at 0001 Add user help for --listen, bug 711396
The copy of the patch that failed is found in:
   /home/arxcruz/Projetos/zenity/.git/rebase-apply/patch
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

Can you please review again?

Kind regards,
Arx Cruz
Comment 9 Sindhu S 2014-04-22 17:19:50 UTC
Created attachment 274898 [details] [review]
help: Update notifications.page

Sorry about the trouble.
I noticed what I did wrong. I didn't remove the old image and the patch was trying to write a new image by the same name.
Fixed up all that, tested the patch by applying it locally.
Thanks.
Comment 10 Arx Cruz 2014-04-26 14:42:36 UTC
Already on master. Thanks for your patch!