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 46429 - Medusa's man pages need to be updated
Medusa's man pages need to be updated
Status: RESOLVED FIXED
Product: medusa
Classification: Deprecated
Component: Documentation
0.2
Other Linux
: Normal normal
: ---
Assigned To: Curtis Hovey
Curtis Hovey
: 46443 (view as bug list)
Depends on:
Blocks:
 
 
Reported: 2001-02-08 05:23 UTC by ville.voutilainen
Modified: 2004-12-22 21:47 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description ville.voutilainen 2001-09-10 00:59:11 UTC
I strongly feel that as medusa is run from a crontab,
it should have a normal man page. Running a not-so-documented
search daemon gives me the creeps, especially since my
ps listing shows
14694 ?        S      0:06 /usr/bin/medusa-idled
16605 ?        SW     0:00 [medusa.cron]
16611 ?        SW     0:00 [medusa-searchd]
16612 ?        RN     3:46 /usr/bin/medusa-indexd
17545 pts/17   S      0:00 grep medusa
even though medusa has been active for ages. Every now and then
hard disk rattles like crazy and I suppose this is medusa-indexd
doing its job. Now, I have tons of network shares mounted and
if medusa indexes all those, it is going to take forever,
but due to the lack of proper man pages I have no way to
figure out how to restrict indexing to ext2 mounts, for
example.

A big question: why isn't medusa implemented as a modified
version of slocate? slocate has (I believe) much of medusa's
functionality, I find having to run several indexing apps
somewhat awkward.



------- Additional Comments From sullivan@eazel.com 2001-02-08 09:34:29 ----

Leaving for Don to assign priority. Seems like a very good idea to me.

The slocate-vs-medusa issue is covered by bug 46335.



------- Additional Comments From don@eazel.com 2001-02-08 11:04:11 ----

This isn't a 1.0 blocker.




------- Additional Comments From dan@eazel.com 2001-02-08 11:17:39 ----

Man pages are good:)  I agree that medusa, along with many other core components
or even GUI applications should have man pages.  If nothing else, it can just
have a brief summary of what the application is, the command-line flags
available (although this may replicate 'foo --help' for many applications), and
a list of relevant files like configuration files.

Who writes the man pages?  I vote that the developers write them.  This is the
historical case, and makes sense since the man pages tend to be more technical
in nature and are aimed at a more technical audience.  If anybody feels that the
Doc/Help system group should write them or help out, I'd be happy to discuss and
reconsider the issue.



------- Additional Comments From vera@eazel.com 2001-02-08 11:39:53 ----

I vote for developers to write man pages, too.



------- Additional Comments From rslomkow@eazel.com 2001-02-08 15:02:00 ----

*** Bug 46443 has been marked as a duplicate of this bug. ***



------- Additional Comments From rebecka@eazel.com 2001-03-06 16:01:44 ----

I've written up a man page and also a man page for medusa-enable-indexing,
the command line tool to enable and disable indexing.
These should get committed next week, after we release 1.0.




------- Additional Comments From rebecka@eazel.com 2001-03-06 16:03:25 ----

(also, if anyone is interested in reading over the medusa man material at
some point, the man pages should be installed with a CVS build.
The current man pages are:
medusa-idled
medusa-searchd
medusa-search-uri
medusa-indexd
medusa.conf

and next week medusa and medusa-enable-indexing

I haven't looked much at the existing man pages; I'll try and get to doing that.




------- Additional Comments From darin@bentspoon.com 2001-04-02 15:37:04 ----

Isn't this already done?



------- Bug moved to this database by unknown@bugzilla.gnome.org 2001-09-09 20:59 -------

The original reporter (ville.voutilainen@radioman.fi) of this bug does not have an account here.
Reassigning to the exporter, unknown@bugzilla.gnome.org.

Comment 1 Curtis Hovey 2003-09-22 04:30:46 UTC
The man pages suplied with Medusa 0.6.0 are complete and correct,
albiet sparce.