Patch that makes README clearer about search paths

Russell Shaw <[email protected]>
Newsgroups gmane.comp.gnome.devtools
Message-ID <[email protected]>
-/README/1.3/Tue Jun 22 07:51:47 2004//
diff -ru devhelp/README devhelp-new/README
--- devhelp/README      Tue Jun 22 17:51:47 2004
+++ devhelp-new/README  Tue Jun 22 17:38:36 2004
@@ -23,29 +23,29 @@
  $HOME/.devhelp/books which are scanned. These locations are ideal for system-
  and user-wide non-GTK+ books.

-The complete list of locations searched for books is:
+In the following search paths, the <name>.devhelp file must be in a directory
+called <name>. Eg: if $DEVHELP_SEARCH_PATH=/usr/local/share/gtk-doc/html
+and /usr/local/share/gtk-doc/html contains: glib, gobject, then the books
+searched will be:
+  /usr/local/share/gtk-doc/html/glib/glib.devhelp
+  /usr/local/share/gtk-doc/html/gobject/gobject.devhelp

-$DEVHELP_SEARCH_PATH
-   ex $DEVHELP_SEARCH_PATH/glib-2.0/glib-2.0.devhelp
+The complete list of locations searched for books is in this order:

-$GNOME2_PATH:
-   ex $GNOME2_PATH/share/devhelp/books/glib-2.0/glib-2.0.devhelp
+$DEVHELP_SEARCH_PATH   This is a colon separated list of absolute paths.
+
+$GNOME2_PATH

  $PREFIX/share/gtk-doc/html ($PREFIX=where you install devhelp),
-   ex /opt/gnome2/share/gtk-doc/html/glib-2.0/glib-2.0.devhelp

  /usr/share/gtk-doc/html
-   ex /usr/share/gtk-doc/html/glib-2.0/glib-2.0.devhelp

  $PREFIX/share/devhelp/books
-   ex /opt/gnome2/share/devhelp/books/glib-2.0/glib-2.0.devhelp

  $HOME/.devhelp/books
-   ex /home/ross/.devhelp/books/glib-2.0/glib-2.0.devhelp

-Note that the name of the directory the .devhelp file is in, and the name of the
-.devhelp file (minus the extension) must match.  There is a DTD available in
-dtd/devhelp-1.dtd which can be used to validate books.  Note that there have
-been several minor changes to the format which break the older books: the base
-attribute is actually respected, the only valid child of <chapters> is <sub>,
-and the author attribute has been removed.
+There is a DTD available in dtd/devhelp-1.dtd which can be used to validate
+devhelp books.  Note that there have been several minor changes to the format
+which break the older books: the base attribute is actually respected, the only
+valid child of <chapters> is <sub>, and the author attribute has been removed.
+
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.