uninformative man page

Bug #1103673 reported by Udvarias Ur
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
ClamTk
New
Undecided
Unassigned

Bug Description

The GUI menus list keyboard alternatives for all 19 menu items, however, none of these keyboard options are described in the man page.

Furthermore, although the View/History (CTRL-H) and the History button produce a list of previous scans and the View/Last Scan Information (CTRL-L) seems to imply that it will display the results of the last scan, there is no mention of where this information is stored.

There is no description of the dialogue box that Advanced/Preferences (CTRL-P) or the Preferences button brings up.

In fact there is no description of what any of the buttons do.

I have a large system with a great deal of data. It took 9 hours to runs a scan of the entire system. As there is no description of what the Home button does in the man page, I clicked it to find out if it brings up a dialogue box like the Preferences button, it started a scan and wiped out all the results from the previous 9 hour scan.

Revision history for this message
Dave M (dave-nerd) wrote :

Hi Udvarias,

Thank you for your feedback.

You are correct - I did not provide much information in the man page. Typically I have viewed man pages as having detailed commandline information - which, of course, ClamTk does not have.

To keep the size of ClamTk relatively small, I keep most documentation online, which does explain most of the options:
http://clamtk.sourceforge.net/help/

There is a FAQ here:
http://clamtk.sourceforge.net/faq.html

Typically "mouseover" events display a brief summary of what happens when you click a button. Please see the attached image - do you see mouseover text when you run ClamTk as seen in the image?

Also, note that scan information from the same day will not overwrite a previous scan - in fact, the information from that scan is appended to the earlier scan information.

Your point about the lack of information is well-taken, though, and I will try to add more as I go.

Thanks,
Dave M

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.