Documentation updates

git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@7246 57a11ea4-9604-0410-9ed3-97b8803252fd

ChangeLog

@@ -1,3 +1,16 @@
+2002-09-26  David Hampton  <hampton@employees.org>
+
+	* README: Updated the section on running gnucash.
+
+	* doc/Makefile.am: Automatically update the date and version
+	number in the man pages.
+	
+	* src/app-file/gnc-file.c(gnc_post_file_open): Change the button
+	labels to be even more explicit.
+	
+	* src/report/standard-reports/balance-sheet.scm: Use the report
+	name from the options instead of a hard coded report title.
+	
 2002-09-25  David Hampton  <hampton@employees.org>
 
 	* src/gnome-utils/gnc-gui-query.c: Add routines to put up the

README

@@ -204,62 +204,32 @@ versions of required packages.
 Running
 -------
 
-FIXME: THIS SECTION IS OBSOLETE NOW.
-
 For GnuCash invocation details, see the manpage in doc/gnucash.1.
 You can also run gnucash --help for the command line options.
 
 You can start GnuCash at the command-line, with "gnucash" or "gnucash
 <filename>", where <filename> is a GnuCash account file.  Sample
-accounts can be found in "data" subdirectory.  *.dat files are GnuCash
+accounts can be found in "data" subdirectory.  *.xac files are GnuCash
 accounts that can opened with the "Open File" menu entry.  *.qif files
 are Quicken Import Format files that can be opened with the "Import
 QIF" menu entry.
 
 GnuCash responds to the following environment variables:
 
-  GNC_RUN_AS_SHELL - if set, makes GnuCash pop up in a guile shell
-  with all the gnucash functions loaded.  From there, you can get the
-  normal startup behavior like this:
-
-    GNC_RUN_AS_SHELL=t ./gnucash
-    guile> (primitive-load (getenv "GNC_BOOTSTRAP_SCM"))
-    guile> (gnc:load "startup.scm")
-    guile> (gnc:main)
-
-  This is the same thing that happens if you don't use this
-  environment variable.  This can be helpful when trying to write and
-  test new .scm files.
-
   GNC_BOOTSTRAP_SCM - the location of the initial bootstrapping scheme code.
 
-  GNC_SCM_LOAD_PATH - an override for the GnuCash scheme load path.
+  GUILE_LOAD_PATH - an override for the GnuCash load path, used when
-  it should be a string representing a proper scheme list.  Each
+  loading scheme files.  It should be a string in the same form as the
-  element can either be a string representing a directory, the symbol
+  PATH or LD_LIBRARY_PATH environment variable.
-  'default which will expand to the default path, or 'current which
+
-  will expand to the current load-path at the instant it encounters
+  GNC_MODULE_PATH - an override for the GnuCash load path, used when
-  the symbol.
+  loading gnucash modules.  It should be a string representing a
+  proper scheme list.  It should be a string in the same form as the
+  PATH or LD_LIBRARY_PATH environment variable.
 
   GNC_DEBUG - enable debugging output.  This allows you to turn on
   debugging earlier in the startup process than you can with --debug.
 
-As an example, here's a wrapper script we used to use to allow you
-to run GnuCash from a local directory:
-
-  #! /bin/sh
-
-  export GNC_BOOTSTRAP_SCM=./share/scm/bootstrap.scm
-  export GNC_SCM_LOAD_PATH='("./share/scm")'
-  export GNC_DEBUG=t
-
-  # Run whichever one was built last.
-  exec ./src/gnucash \
-    --debug \
-    --share-dir ./share \
-    --config-dir ./etc \
-    --doc-path '("./doc/html/C")' \
-    "$@"
-
 
 ####################
 Internationalization

doc/Makefile.am

@@ -25,5 +25,27 @@ EXTRA_DIST = \
   build-solaris.txt \
   build-suse.txt \
   gnome-hackers.txt \
-  gnc-prices.1 \
+  gnc-prices.1.in \
-  gnucash.1
+  gnucash.1.in
+
+## We borrow guile's convention and use @-...-@ as the substitution
+## brackets here, instead of the usual @...@.  This prevents autoconf
+## from substituting the values directly into the left-hand sides of
+## the sed substitutions.
+gnc-prices.1: gnc-prices.1.in
+	rm -f $@.tmp
+	sed < $< > $@.tmp \
+            -e 's:@-VERSION-@:${VERSION}:g' \
+            -e 's:@-DATE-@:$(shell date +'%B %Y'):g'
+	chmod +x $@.tmp
+	mv $@.tmp $@
+
+gnucash.1: gnucash.1.in
+	rm -f $@.tmp
+	sed < $< > $@.tmp \
+            -e 's:@-VERSION-@:${VERSION}:g' \
+            -e 's:@-DATE-@:$(shell date +'%B %Y'):g'
+	chmod +x $@.tmp
+	mv $@.tmp $@
+
+DISTCLEANFILES = gnc-prices.1 gnucash.1

doc/gnc-prices.1.in

@@ -2,7 +2,7 @@
 .\" Process this file with
 .\" groff -man -Tascii foo.1
 .\"
-.TH GNC-PRICES 1 "January 2002" Version "1.6.6"
+.TH GNC-PRICES 1 "@-DATE-@" Version "@-VERSION-@"
 .SH NAME
 gnc-prices \- update stock prices from online sources for gnucash
 .SH SYNOPSIS

doc/gnucash.1.in

@@ -2,7 +2,7 @@
 .\" Process this file with
 .\" groff -man -Tascii foo.1
 .\"
-.TH GNUCASH 1 "January 2002" Version "1.6.6"
+.TH GNUCASH 1 "@-DATE-@" Version "@-VERSION-@"
 .SH NAME
 gnucash \- personal finance manager
 .SH SYNOPSIS
@@ -65,27 +65,24 @@ MANUALLY!
 Enable debugging output.  This allows you to turn on the debugging
 earlier in the startup process than you can with
 .B --debug.
-.IP GNC_RUN_AS_SHELL
+.IP GUILE_LOAD_PATH
-If set, makes
-.B GnuCash
-pop up in a guile shell with all the GnuCash functions loaded. See
-the README for more details.
-.IP GNC_BOOTSTRAP_SCM
-Location of the initial bootstrapping scheme code.  Hopefully, you
-won't need to change this.
-.IP GNC_SCM_LOAD_PATH
 An override for the
 .B GnuCash
 scheme load path. You shouldn't need to alter this.  For more
 information see the README file.
+.IP GNC_MODULE_PATH
+An override for the
+.B GnuCash
+scheme load path for
+.B Gnucash
+modules. You shouldn't need to alter this.  For more
+information see the README file.
 .SH BUGS
 .B Please report any bugs using the bug reporting form on the
 .B GnuCash
 web site.
 
 .SH "SEE ALSO"
-.BR gnc-prices (1),
-
 .B GnuCash
 has extensive on-line help available from the "help" menu.