diff --git a/configure.in b/configure.in index 4746b6f5d..d91555d9a 100644 --- a/configure.in +++ b/configure.in @@ -277,8 +277,6 @@ src/calendars/Makefile src/data/Makefile src/data/templates/Makefile src/po/Makefile -doc/omf.make -doc/xmldocs.make doc/Makefile doc/gramps-manual/Makefile doc/gramps-manual/C/Makefile diff --git a/doc/gramps-manual/C/gramps-manual.xml b/doc/gramps-manual/C/gramps-manual.xml index e68c6afa9..2fc74ace6 100644 --- a/doc/gramps-manual/C/gramps-manual.xml +++ b/doc/gramps-manual/C/gramps-manual.xml @@ -91,7 +91,7 @@ - + @@ -286,7 +286,7 @@ a few thousand people). Its is hard to tell which format is better, since this is a typical - tradeoff situation. If you are starting your research then you are likely + trade-off situation. If you are starting your research then you are likely to be fine with the regular XML database. If you have tons of data to import describing thousands upon thousands of people, then you are probably better off with ZODB. @@ -328,7 +328,7 @@ Open example database Select this item to load an example database shipped - with &app;. This database is composed of fictious people and serves as + with &app;. This database is composed of fictitious people and serves as a useful example when learning how to work with &app;. @@ -572,7 +572,7 @@ The double-arrow button to the right of the Active person list-box allows you to exchange the currently selected spouse (Current spouse) with the Active person. Double-clicking on the Active person allows the - editting of Active person's data. Double-clicking on the Current spouse + editing of Active person's data. Double-clicking on the Current spouse allows you to edit their relationship information. To add a spouse, click + to the right of the spouse box. To remove Current spouse, click - to the diff --git a/doc/gramps.1 b/doc/gramps.1 index 068495d8b..0f9b69c6c 100644 --- a/doc/gramps.1 +++ b/doc/gramps.1 @@ -33,8 +33,9 @@ wide by almost all other geneology software. .SH OPTIONS .TP .BI \-f " FORMAT" -Explicitly specify format of the filename. If this option is not given, the -format of each file is guessed according to its extension. Formats available +Explicitly specify format of the filename given by preceding \fB\-i\fR or +\fB\-o\fR options. If the \fB\-f\fR option is not given, the format of each +file is guessed according to its extension. Formats available for import are \fBgramps\fR, \fBgedcom\fR, and \fBgramps\-pkg\fR. Formats available for export are \fBgramps\fR, \fBgedcom\fR, \fBgramps\-pkg\fR, and \fBiso\fR. @@ -77,6 +78,23 @@ dumped to \fIstdout\fR (if these are exceptions handled by gramps) or or to \fIstderr\fR (if these are not handled). Use usual shell redirections of \fIstdout\fR and \fIstderr\fR to save messages and errors in files. +.SH EXAMPLES +.TP +To import three databases (whose formats can be determined from their names) and then check the resulting database for errors, one may type: +\fBgramps\fR \fB\-i\fR \fIfile1.ged\fR \fB\-i\fR \fIfile2.tgz\fR \fB\-i\fR \fI~/db3\fR \fB\-a\fR \fIcheck\fR +.TP +To explicitly specify the formats in the above example, append filenames with appropriate \fB\-f\fR options: +\fBgramps\fR \fB\-i\fR \fIfile1.ged\fR \fB\-f\fR \fIgedcom\fR \fB\-i\fR \fIfile2.tgz\fR \fB\-f\fR \fIgramps-pkg\fR \fB\-i\fR \fI~/dir3\fR \fB\-f\fR \fIgramps\fR \fB\-a\fR \fIcheck\fR +.TP +To record the database resulting from all imports, supply \fB\-o\fR flag (use \fB\-f\fR if the filename does not allow gramps to guess the format): +\fBgramps\fR \fB\-i\fR \fIfile1.ged\fR \fB\-i\fR \fIfile2.tgz\fR \fB\-o\fR \fI~/new-package\fR \fB\-f\fR \fIgramps-pkg\fR +.TP +To import three databases and start interactive gramps session with the result: +\fBgramps\fR \fB\-i\fR \fIfile1.ged\fR \fB\-i\fR \fIfile2.tgz\fR \fB\-i\fR \fI~/db3\fR +.TP +Finally, to start normal interactive session type: +\fBgramps\fR + .SH CONCEPTS Supports a python\-based plugin system, allowing import and export writers, report generators, tools, and display filters to be added without modification diff --git a/doc/omf.make b/doc/omf.make index eeb4f8115..d6dfa82be 100644 --- a/doc/omf.make +++ b/doc/omf.make @@ -26,7 +26,7 @@ # Version: 0.1.2 (last updated: March 20, 2002) # -omf_dest_dir=$(datadir)/omf/gramps +omf_dest_dir=$(datadir)/omf/@PACKAGE@ scrollkeeper_localstate_dir = $(localstatedir)/scrollkeeper omf: omf_timestamp diff --git a/doc/omf.make.in b/doc/omf.make.in deleted file mode 100644 index d6dfa82be..000000000 --- a/doc/omf.make.in +++ /dev/null @@ -1,53 +0,0 @@ -# -# No modifications of this Makefile should be necessary. -# -# This file contains the build instructions for installing OMF files. It is -# generally called from the makefiles for particular formats of documentation. -# -# Note that you must configure your package with --localstatedir=/var/lib -# so that the scrollkeeper-update command below will update the database -# in the standard scrollkeeper directory. -# -# If it is impossible to configure with --localstatedir=/var/lib, then -# modify the definition of scrollkeeper_localstate_dir so that -# it points to the correct location. Note that you must still use -# $(localstatedir) in this or when people build RPMs it will update -# the real database on their system instead of the one under RPM_BUILD_ROOT. -# -# Note: This make file is not incorporated into xmldocs.make because, in -# general, there will be other documents install besides XML documents -# and the makefiles for these formats should also include this file. -# -# About this file: -# This file was taken from scrollkeeper_example2, a package illustrating -# how to install documentation and OMF files for use with ScrollKeeper -# 0.3.x and 0.4.x. For more information, see: -# http://scrollkeeper.sourceforge.net/ -# Version: 0.1.2 (last updated: March 20, 2002) -# - -omf_dest_dir=$(datadir)/omf/@PACKAGE@ -scrollkeeper_localstate_dir = $(localstatedir)/scrollkeeper - -omf: omf_timestamp - -omf_timestamp: $(omffile) - -for file in $(omffile); do \ - scrollkeeper-preinstall $(docdir)/$(docname).xml $(srcdir)/$$file $(srcdir)/$$file.out; \ - done - touch omf_timestamp - -install-data-hook-omf: - $(mkinstalldirs) $(DESTDIR)$(omf_dest_dir) - for file in $(omffile); do \ - $(INSTALL_DATA) $(srcdir)/$$file.out $(DESTDIR)$(omf_dest_dir)/$$file; \ - done - -scrollkeeper-update -p $(scrollkeeper_localstate_dir) -o $(DESTDIR)$(omf_dest_dir) - -uninstall-local-omf: - -for file in $(srcdir)/*.omf; do \ - basefile=`basename $$file`; \ - rm -f $(omf_dest_dir)/$$basefile; \ - done - -rmdir $(omf_dest_dir) - -scrollkeeper-update -p $(scrollkeeper_localstate_dir) diff --git a/doc/xmldocs.make b/doc/xmldocs.make index 5ccc121e4..28361925d 100644 --- a/doc/xmldocs.make +++ b/doc/xmldocs.make @@ -36,7 +36,7 @@ # ************* Begin of section some packagers may need to modify ************** # This variable (docdir) specifies where the documents should be installed. # This default value should work for most packages. -docdir = $(datadir)/gnome/help/gramps/$(lang) +docdir = $(datadir)/gnome/help/@PACKAGE@/$(lang) # ************** You should not have to edit below this line ******************* xml_files = $(entities) $(docname).xml diff --git a/doc/xmldocs.make.in b/doc/xmldocs.make.in deleted file mode 100644 index 28361925d..000000000 --- a/doc/xmldocs.make.in +++ /dev/null @@ -1,95 +0,0 @@ -# -# No modifications of this Makefile should be necessary. -# -# To use this template: -# 1) Define: figdir, docname, lang, omffile, and entities in -# your Makefile.am file for each document directory, -# although figdir, omffile, and entities may be empty -# 2) Make sure the Makefile in (1) also includes -# "include $(top_srcdir)/doc/xmldocs.make" and -# "dist-hook: app-dist-hook". -# 3) Optionally define 'entities' to hold xml entities which -# you would also like installed -# 4) Figures must go under $(figdir)/ and be in PNG format -# 5) You should only have one document per directory -# 6) Note that the figure directory, $(figdir)/, should not have its -# own Makefile since this Makefile installs those figures. -# -# example Makefile.am: -# figdir = figures -# docname = scrollkeeper-manual -# lang = C -# omffile=scrollkeeper-manual-C.omf -# entities = fdl.xml -# include $(top_srcdir)/help/xmldocs.make -# dist-hook: app-dist-hook -# -# About this file: -# This file was taken from scrollkeeper_example2, a package illustrating -# how to install documentation and OMF files for use with ScrollKeeper -# 0.3.x and 0.4.x. For more information, see: -# http://scrollkeeper.sourceforge.net/ -# Version: 0.1.2 (last updated: March 20, 2002) -# - - -# ************* Begin of section some packagers may need to modify ************** -# This variable (docdir) specifies where the documents should be installed. -# This default value should work for most packages. -docdir = $(datadir)/gnome/help/@PACKAGE@/$(lang) - -# ************** You should not have to edit below this line ******************* -xml_files = $(entities) $(docname).xml -omf_dir=$(top_srcdir)/omf-install - -EXTRA_DIST = $(xml_files) $(omffile) -CLEANFILES = omf_timestamp - -include $(top_srcdir)/doc/omf.make - -all: omf - -$(docname).xml: $(entities) - -ourdir=`pwd`; \ - cd $(srcdir); \ - cp $(entities) $$ourdir - -app-dist-hook: - if test "$(figdir)"; then \ - $(mkinstalldirs) $(distdir)/$(figdir); \ - for file in $(srcdir)/$(figdir)/*.png; do \ - basefile=`echo $$file | sed -e 's,^.*/,,'`; \ - $(INSTALL_DATA) $$file $(distdir)/$(figdir)/$$basefile; \ - done \ - fi - -install-data-local: omf - $(mkinstalldirs) $(DESTDIR)$(docdir) - for file in $(xml_files); do \ - cp $(srcdir)/$$file $(DESTDIR)$(docdir); \ - done - if test "$(figdir)"; then \ - $(mkinstalldirs) $(DESTDIR)$(docdir)/$(figdir); \ - for file in $(srcdir)/$(figdir)/*.png; do \ - basefile=`echo $$file | sed -e 's,^.*/,,'`; \ - $(INSTALL_DATA) $$file $(DESTDIR)$(docdir)/$(figdir)/$$basefile; \ - done \ - fi - -install-data-hook: install-data-hook-omf - -uninstall-local: uninstall-local-doc uninstall-local-omf - -uninstall-local-doc: - -if test "$(figdir)"; then \ - for file in $(srcdir)/$(figdir)/*.png; do \ - basefile=`echo $$file | sed -e 's,^.*/,,'`; \ - rm -f $(docdir)/$(figdir)/$$basefile; \ - done; \ - rmdir $(DESTDIR)$(docdir)/$(figdir); \ - fi - -for file in $(xml_files); do \ - rm -f $(DESTDIR)$(docdir)/$$file; \ - done - -rmdir $(DESTDIR)$(docdir) -