From 63472619b52678f869c710fdd353120e630c07b4 Mon Sep 17 00:00:00 2001 From: Arturo Espinosa Date: Mon, 17 May 1999 23:15:39 +0000 Subject: Add Docbook framework for documenting Gnomecal -miguel svn path=/trunk/; revision=928 --- calendar/doc/C/Makefile.am | 44 ++++++++++++ calendar/doc/C/gnomecal.sgml | 156 +++++++++++++++++++++++++++++++++++++++++++ calendar/doc/C/topic.dat | 2 + 3 files changed, 202 insertions(+) create mode 100644 calendar/doc/C/Makefile.am create mode 100644 calendar/doc/C/gnomecal.sgml create mode 100644 calendar/doc/C/topic.dat (limited to 'calendar/doc/C') diff --git a/calendar/doc/C/Makefile.am b/calendar/doc/C/Makefile.am new file mode 100644 index 0000000000..be6533d715 --- /dev/null +++ b/calendar/doc/C/Makefile.am @@ -0,0 +1,44 @@ +gnomecal_helpdir = $(datadir)/gnome/help/gnomecal/C + +gnomecal_help_DATA = \ + gnomecal.html \ + topic.dat + +SGML_FILES = \ + gnomecal.sgml + +EXTRA_DIST = \ + topic.dat \ + $(SGML_FILES) + +all: + +gnomecal.html: gnomecal/gnomecal.html + -cp gnomecal/gnomecal.html . + +gnomecal/gnomecal.html: $(SGML_FILES) + -db2html gnomecal.sgml + +dist-hook: + mkdir $(distdir)/gnomecal + -cp gnomecal/*.html gnomecal/*.css $(distdir)/gnomecal + -cp gnomecal.html $(distdir) + mkdir $(distdir)/images + -cp images/*.gif images/*.jpg $(distdir)/images + +install-data-local: gnomecal.html + $(mkinstalldirs) $(gnomecal_helpdir)/images + -for file in $(srcdir)/gnomecal/*.html $(srcdir)/gnomecal/*.css; do \ + basefile=`basename $$file`; \ + $(INSTALL_DATA) $(srcdir)/$$file $(gnomecal_helpdir)/$$basefile; \ + done + -for file in $(srcdir)/images/*.jpg $(srcdir)/images/*.gif; do \ + $(INSTALL_DATA) $(srcdir)/$$file $(gnomecal_helpdir)/images;\ + done + +gnomecal.ps: gnomecal.sgml + -db2ps $< + +gnomecal.rtf: gnomecal.sgml + -db2rtf $< + diff --git a/calendar/doc/C/gnomecal.sgml b/calendar/doc/C/gnomecal.sgml new file mode 100644 index 0000000000..92783cc06a --- /dev/null +++ b/calendar/doc/C/gnomecal.sgml @@ -0,0 +1,156 @@ + + + + + GNOME calendar user's manual + + + Miguel de Icaza + Amozurrutia + +
+ miguel@gnu.org +
+ + + + + 1998, 1999 Miguel de Icaza + + + This documentation is free software; you can redistribute + it and/or modify it under the terms of the GNU General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later + version. + + This program is distributed in the hope that it will be + useful, but WITHOUT ANY WARRANTY; without even the implied + warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + See the GNU General Public License for more details. + + You should have received a copy of the GNU General Public + License along with this program; if not, write to the Free + Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, + MA 02111-1307 USA + + For more details see the file COPYING in the source + distribution of GNOME. + + + + + + + Command line options + + + The following command line options are recognized by the + gnomecal program. You can use these + options to alter the behaviour of the program or to quickly + query the program for appointments, and to do items from the + command line without requiring an X display. These are usefu + for example to include in scripts. + + + + + + + + --events. Displays the events for the + date specified (or today, if no date is specified). + + + + + + --from DATE. Define the beginning of + the range for the event display, or the startup day on the + calenday views. By default, the event will span the whole + day specified in DATE. + + + + + + --to DATE. Define the range end for + the event display. If this is not specified, it will + default to the end of the day specified by the + --from option. + + + + + + --file FILE. Set the calendar to the + FILE specified on the command line. + + + + + + --todo. Dumps the to-do values to + standard output. + + + + + + --userfile. Use this if you want to + force the file to be loaded to be the default user's + calendar (this is the default, only used to override the + --file if you have some sort of macro. + + + + + + --geometry. Used to specity the + startup geometry of the application (location and size). + + + + + + --view VIEWMODE. Use this to specify + the startup view that should be used. + VIEWMODE is one of: dayview, + weekview, monthview, yearview. + + + + + + + + DATE is interpreted as being in the local + time-zone, unless a specific timezone is specified. Examples + of valid date specifications include: "1 month ago", "2 hours + ago", "400000 seconds ago", "last year", "last Monday", + "yesterday", "a fortnight ago", "3/31/92 10:00:07 PST", "January + 23, 1987 10:05pm", "22:00 GMT". + + + + + Technical information about the GNOME calendar + + + Currently, the GNOME calendar uses the vCal file format standard + for storing and loading its appointment and todo database. This + standard is widely used in various other calendar applications, + so it provides a good mechanism for exchanging appointments. + + + In the future the GNOME calendar will support the upcoming + iCalendar specification as well. + + + If you want to know more about the vCal specification, you can + check the Internet + Mail Consortium (http://www.imc.org) for the details. + + + \ No newline at end of file diff --git a/calendar/doc/C/topic.dat b/calendar/doc/C/topic.dat new file mode 100644 index 0000000000..23af169d62 --- /dev/null +++ b/calendar/doc/C/topic.dat @@ -0,0 +1,2 @@ +gnomecal.html Manual +cmdline.html Command line options -- cgit v1.2.3