How to install and use Debian NewbieDOC documents on your computer
From NewbieDOC
- Chris Lale
- chrislale AT users DOT berlios DOT de
Go to NewbieDOC index
Revision History
Revision 1.0 | 28th November 2007 | Revised by Chris Lale | ||||||||||
Initial release. | ||||||||||||
| ||||||||||||
Revision 1.1 | 26th September 2009 | Revised by Chris Lale | ||||||||||
Updated for Debian Squeeze. | ||||||||||||
A snapshot of Debian NewbieDOC is available as a Debian package. You can install it on a Debian system and access the web pages using the "newbiedoc" command, from the Debian menu in X11 or using an online documentation reader such as "dhelp", "doccentral" or "dwww".
1 Install the newbiedoc package1.1 Installing from the NewbieDOC project siteThe newbiedoc package in the Debian Stable repository may be a little out of date. You can get the most recent version from http://developer.berlios.de/projects/newbiedoc/ . First create a suitable directory (folder) in your Home directory for the downloaded file. If you are using the X Window System, you can do this with your file manager. Otherwise, use the command line in a terminal (or terminal window). Make the directory with mkdir. $ mkdir -p ~/downloads/debs Note: The -p switch makes sure that any parent directories that don't exist are created. The tilde (~) starts the path at the root of your Home directory. Visit the project site http://developer.berlios.de/projects/newbiedoc/ with your web browser to download the latest newbiedoc-deb release. The package file has the form newbiedoc_n.n.n-n_all.deb; for example, newbiedoc_0.7.0-1_all.deb. Download this file to the download directory you just created. You must do the next bit from the command line. Change directory (cd) to the directory containing the downloaded .deb package. Tip: You can use tab completion to fill in much of the path. Tap the "Tab" key after the first letter or two of each word in the path. $ cd downloads/debs Switch user (su) to user root. $ su Install the package using the Debian package manager dpkg. # dpkg -i newbiedoc_0.7.0-1_all.deb Selecting previously deselected package newbiedoc. (Reading database ... 194453 files and directories currently installed.) Unpacking newbiedoc (from newbiedoc_0.7.0-1_all.deb) ... Setting up newbiedoc (0.7.0-1) ... # Important: Switch back to normal user as soon as possible. This avoids accidental damage to your system.
# exit The newbiedoc package is now installed. You can remove it with the usual tools (Apt, Aptitude or Synaptic), or you can use dpkg as user root. # dpkg -r newbiedoc Note: To install the package with dpkg you supply the filename, to remove the package with dpkg you supply the package name. 2 Accessing the NewbieDOC documentation directlyYou can see the NewbieDOC documents in a web browser. They are in the directory /usr/share/doc/newbiedoc. Use this URL: file:///usr/share/doc/newbiedoc/newbiedoc.berlios.de/wiki/Index.html There are a couple of shortcuts for doing this as follows. 2.1 From the command lineThe newbiedoc command runs your favourite browser for X and opens the NewbieDOC Index file. If you are not using the X Window System, the newbiedoc command will open your favourite non-graphical browser instead. $ newbiedoc Tip: You can change your favourite browsers, as user root, using the commands update-alternatives --config x-www-browser and update-alternatives --config www-browser. 2.2 From the X Window SystemYou can run the newbiedoc command directly from the Debian menu. First make sure that the Debian menu is visible. You can do this in Gnome from The System menu: System -> Preferences -Main Menu Make sure that Debian (in the Items list) is ticked. After this, Newbiedoc documents are always available from Applications -> Debian -> Help -> NewbieDOC 3 Accessing the NewbieDOC documentation using online documentation systemsWhen you install the newbiedoc package, it registers the NewbieDOC documents with doc-base. The doc-base system makes documentation available to Debian's online documentation systems, currently doc-central, dhelp and dwww. Each of these systems depend on having a webserver (eg apache2) installed. These online documentation systems allow you to view your Debian system's documentation (man pages, info files, READMEs, etc) in your web browser. All three systems have similar functionality. which one you use is a matter of personal preference. Only details for dwww are given here. 3.1 Using dwww3.1.1 Installing the softwareInstall the dwww package using, for example, Apt, Aptitude or Synaptic. To be able to use dwww's search function, you must also install swish++ (the document indexing system). To install these packages from the command line you could enter this command as user root: # aptitude install dwww swish++ 3.1.2 Updating the database for dwwwYou can index all the documentation registered with doc-base (including NewbieDOC) by running the dwww-index++ command as user root. This may take a while. The dwww-index++ command is also run automatically by cron every week. # dwww-index++ Note: Running dwww-index++ will not affect dwww's database of package information eg man pages. If you install new packages, update dwww's cache by running dwww-refresh-cache, as user root, to make sure that the package information is available.
# dwww-refresh-cache 3.1.3 Viewing the NewbieDOC documentationJust as with the newbiedoc command, you can run dwww either from the command line $ dwww or from the Debian menu. (Desktop's main menu) -> Debian -> Help -> Dwww Your browser will display dwww's home page. You can find NewbieDOC documents in the registered documentation index. For instance, to see a list of all NewbieDOC documents, type "newbiedoc" in the search box, select the last radio button ("registered documentation index") and click on the "Search" button. Fig 1: dwww's home page.
4 Appendix A: LicenceCopyright (c) 2007-2009 Chris Lale. chrislale AT users DOT berlios DOT de.
|