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 665532 - --search option is not documented in man and in --help
--search option is not documented in man and in --help
Status: RESOLVED FIXED
Product: tomboy
Classification: Applications
Component: Documentation
unspecified
Other Linux
: Normal normal
: ---
Assigned To: Jared Jennings
Maintainers of Gnome user documentation
Depends on:
Blocks:
 
 
Reported: 2011-12-04 10:00 UTC by Tomáš Hnyk
Modified: 2011-12-07 21:36 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Adds missing command line options to the MAN page (1.06 KB, patch)
2011-12-06 19:42 UTC, Jared Jennings
needs-work Details | Review
Adds missing command line options to the MAN page (1.06 KB, patch)
2011-12-06 23:35 UTC, Jared Jennings
accepted-commit_now Details | Review

Description Tomáš Hnyk 2011-12-04 10:00:09 UTC
Connected to bug 473549 - currently, there is no gui to enable tomboy  to start minimized. Command line option is fine but it is undocumented, I had to search the web for it.

Thereore, please include --search and --icon options in the --help command and in man.
Comment 1 Sandy Armstrong 2011-12-04 17:22:11 UTC
There is no --icon option.
Comment 2 Tomáš Hnyk 2011-12-04 20:26:53 UTC
Ah, sorry, my bad, I was confused by this: http://kenjiru.ro/blog/2011/05/start-tomboy-minimized-on-ubuntu-1104 and this: http://askubuntu.com/questions/37582/where-is-the-tomboy-panel-applet

I can see now that having just tomboy in startup applications makes it start minimized. 

However, the --search option (with the mention that it is the default in the .desktop file) is undocumented. So users need to refer to the web to start tomboy minimized.
Comment 3 Jared Jennings 2011-12-06 06:00:01 UTC
Looks like we are also missing
--panel-applet
--note-path

Is that true?
Comment 4 Tomáš Hnyk 2011-12-06 08:38:54 UTC
Weel, note-path is there on my system (Ubuntu 11.10) in --help
--note-path [path]		Load/store note data in this directory.
but it is not in man. 
--panel-applet is nowhere to be found:-).
Comment 5 Jared Jennings 2011-12-06 19:42:39 UTC
Created attachment 202934 [details] [review]
Adds missing command line options to the MAN page
Comment 6 Jared Jennings 2011-12-06 19:43:10 UTC
Tomáš,
You mind taking a look at the page I created and see if it makes sense to you?
(In reply to comment #4)
> Weel, note-path is there on my system (Ubuntu 11.10) in --help
> --note-path [path]        Load/store note data in this directory.
> but it is not in man. 
> --panel-applet is nowhere to be found:-).
Comment 7 Tomáš Hnyk 2011-12-06 19:50:56 UTC
Looks fine to me. Will this be displayed after running tomboy --help too?
Comment 8 Sandy Armstrong 2011-12-06 19:51:31 UTC
Review of attachment 202934 [details] [review]:

Comments within

::: data/tomboy.1
@@ +59,3 @@
 .TP
+.B \-\-panel-applet
+Launches Tomboy as an panel applet. This feature is not meant for users, but must be utilized only by GNOME-SHELL.

s/an/a

Also, this is used by gnome-panel, not gnome-shell (and no need for all caps).

@@ +62,3 @@
+.TP
+.B \-\-search TEXT
+Searches notes for the specified TEXT and opens the search all notes window with the search text

I would capitalize Search All Notes
Comment 9 Jared Jennings 2011-12-06 19:55:18 UTC
Your specifically referring to panel-applet?
Sandy says that is is only used by gnome-panel. Which means that it doesn't do the user any good really. I'm thinking that this shouldn't be added to the usage help output. I'm fine with adding it to the MAN page and maybe even the Tomboy help website.

I'm open for input though

(In reply to comment #7)
> Looks fine to me. Will this be displayed after running tomboy --help too?
Comment 10 Tomáš Hnyk 2011-12-06 19:59:06 UTC
(In reply to comment #9)
> Your specifically referring to panel-applet?
> Sandy says that is is only used by gnome-panel. Which means that it doesn't do
> the user any good really. I'm thinking that this shouldn't be added to the
> usage help output. I'm fine with adding it to the MAN page and maybe even the
> Tomboy help website.
> 
> I'm open for input though
> 
> (In reply to comment #7)
> > Looks fine to me. Will this be displayed after running tomboy --help too?

Not specifically. I cannot judge whether it is useful but remember I stumbled across this when trying to set tomboy to autostart with minimized window. Does not this option do just this in legacy gnome (I do not know, just asking).
Comment 11 Sandy Armstrong 2011-12-06 20:13:29 UTC
(In reply to comment #10)

> Does not this option do just this in legacy gnome (I do not know, just asking).

Starting with --panel-applet will cause Tomboy to show an applet in the legacy gnome-panel, but only if Tomboy is being started by the panel itself.  As a user, you can't really do anything with that option.
Comment 12 Jared Jennings 2011-12-06 23:35:05 UTC
Created attachment 202952 [details] [review]
Adds missing command line options to the MAN page

Contains Sandy's patch-review comments.
Comment 13 Sandy Armstrong 2011-12-07 00:34:47 UTC
Review of attachment 202952 [details] [review]:

Looks good.
Comment 14 Jared Jennings 2011-12-07 21:36:21 UTC
Committed e4f6505ed831c92ad997146919b8ab8d3e4ffbe5