GNOME Bugzilla – Bug 398138
nettool help file it's only a skeleton, it needs a proper documentation
Last modified: 2012-10-02 05:21:31 UTC
Documentation Section: GNOME Nettool Manual V2.7 2.3. To Open a File To open a file, choose File → Open to display the Open File dialog. Select the file that you want to open, then click Open. The file is displayed in the GNOME Nettool window. You can open multiple files in GNOME Nettool. The application displays one file at a time in the application window. The application adds a tab for each open file to the window. To display another open file, click on the tab that corresponds to the file. To create a new GNOME Nettool window for each file that is open, drag the tab corresponding to each file to the desktop background. You can also use the Documents menu to move between the open files. You can choose Documents → Move to New Window to move a document to a new GNOME Nettool window. The application records the paths and filenames of the five most recent files that you edited and displays the files as menu items on the File menu. You can also click on the icon on the toolbar to display the list of recent files. 2.4. To Open Multiple Files from a Command Line You can run GNOME Nettool from a command line and open a single file or multiple files. To open multiple files from a command line, type the following command, then press Return: gedit file1.txt file2.txt file3.txt When the application starts, the files that you specify are displayed in the GNOME Nettool window. For more information on how to run GNOME Nettool from a command line, see GNOME Nettool(1). Correct version: It shouldn't even talk about opening files with gnome-nettool I think. Unless there are some possibilities I don't know about. And the link at the end goes to the gedit manual instead of the gnome-nettool manual. Other information: In fact the whole help file about gnome-nettool seems to be a copy of the gedit help file... By the way, while filling out the bug report, I had a hard time finding out the version of me gnome desktop under OpenSUSE 10.2. After searching on the internet, I just typed gnome-about, which was much easier. I think it should be added to the tips indicating how to get the version number. ;) And is there a way to participate in the documentation writing? Maybe I could help, altough I don't have a lot of free time.
Sorry, I read the e-mails after reporting this, so this is probably "NOTGNOME" too...
No, I think one really is a bug... I seem to remember reading that someone copied the gedit help file to set this manual up.
Just noticed this bug is in gnome-user-docs product. Could you move it please? I don't know where Nettool lives in bugzilla, but it's not here, and it should have its own documentation component.
The version in SVN seems to be more recent. However, there is a more recent template than the gedit manual, in gnome-doc-utils: http://svn.gnome.org/viewcvs/gnome-doc-utils/trunk/data/templates/ I would recomment to nettool maintainers that they use that one.
Thanks mike and Joachim for the recommendation. Certainly, we need documentation for Gnome Nettool. Any help is welcomed in that direction.
Anyway, the help documentation itself doesn't say anything about gedit (as far as I see). However, the documention is still missing. So, I'm changin the summary to reflect the carency of documentation.
Created attachment 215088 [details] [review] Remove help; it's been a useless skeleton for almost 8 years
Review of attachment 215088 [details] [review]: I added new documentation in Mallard.
This problem has been fixed in the development version. The fix will be available in the next major software release. Thank you for your bug report.