summaryrefslogtreecommitdiffstats
path: root/doc/man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/Makefile.am3
-rw-r--r--doc/man/krecipes.1187
2 files changed, 190 insertions, 0 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
new file mode 100644
index 0000000..c4c6d2c
--- /dev/null
+++ b/doc/man/Makefile.am
@@ -0,0 +1,3 @@
+tmpdir = $(mandir)/man1
+tmp_DATA= krecipes.1
+EXTRA_DIST=$(tmp_DATA)
diff --git a/doc/man/krecipes.1 b/doc/man/krecipes.1
new file mode 100644
index 0000000..aaf56f7
--- /dev/null
+++ b/doc/man/krecipes.1
@@ -0,0 +1,187 @@
+.\" Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH KRECIPES 1 "May 2009"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+Krecipes \- The TDE Cookbook
+.SH SYNOPSIS
+.B krecipes
+[Qt\-options] [TDE\-options] [options]
+.SH DESCRIPTION
+.B Krecipes
+is a program that lets you to manage your recipes, create shopping
+lists, choose a recipe based on available ingredients and plan your
+menu/diet in advance.
+.PP
+This manual page briefly describes its command line options.
+.SH OPTIONS
+This program follows the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+.TP
+.B \-\-convert-sqlite3
+Convert the current SQLite 2.x database to SQLite 3 and exit
+.SS Generic options:
+.TP
+.B \-\-help
+Show help about options
+.TP
+.B \-\-help\-qt
+Show Qt specific options
+.TP
+.B \-\-help\-tde
+Show TDE specific options
+.TP
+.B \-\-help\-all
+Show all options
+.TP
+.B \-\-author
+Show author information
+.TP
+.B \-v, \-\-version
+Show version information
+.TP
+.B \-\-license
+Show license information
+.TP
+.B \-\-
+End of options
+.SS Qt options
+.TP
+.B \-\-display <displayname>
+Use the X\-server display 'displayname'
+.TP
+.B \-\-session <sessionId>
+Restore the application for the given 'sessionId'
+.TP
+.B \-\-cmap
+Causes the application to install a private color map on an 8-bit
+display
+.TP
+.B \-\-ncols <count>
+Limits the number of colors allocated in the color cube on an 8-bit
+display, if the application is using the QApplication::ManyColor color
+specification
+.TP
+.B \-\-nograb
+tells Qt to never grab the mouse or the keyboard
+.TP
+.B --dograb
+running under a debugger can cause an implicit \-nograb, use \-dograb
+to override
+.TP
+.B \-\-sync
+switches to synchronous mode for debugging
+.TP
+.B \-\-fn, \-\-font <fontname>
+defines the application font
+.TP
+.B \-\-bg, \-\-background <color>
+sets the default background color and an application palette (light
+and dark shades are calculated)
+.TP
+.B \-\-fg, \-\-foreground <color>
+sets the default foreground color
+.TP
+.B \-\-btn, \-\-button <color>
+sets the default button color
+.TP
+.B \-\-name <name>
+sets the application name
+.TP
+.B \-\-title <title>
+sets the application title (caption)
+.TP
+.B \-\-visual TrueColor
+forces the application to use a TrueColor visual on an 8\-bit display
+.TP
+.B \-\-inputstyle <inputstyle>
+sets XIM (X Input Method) input style. Possible values are onthespot,
+overthespot, offthespot and root
+.TP
+.B \-\-im <XIM server>
+set XIM server
+.TP
+.B \-\-noxim
+disable XIM
+.TP
+.B \-\-reverse
+mirrors the whole layout of widgets
+.SS TDE options
+.TP
+.B \-\-caption <caption>
+Use 'caption' as name in the titlebar
+.TP
+.B \-\-icon <icon>
+Use 'icon' as the application icon
+.TP
+.B \-\-miniicon <icon>
+Use 'icon' as the icon in the titlebar
+.TP
+.B \-\-config <filename>
+Use alternative configuration file
+.TP
+.B \-\-dcopserver <server>
+Use the DCOP Server specified by 'server'
+.TP
+.B \-\-nocrashhandler
+Disable crash handler, to get core dumps
+.TP
+.B \-\-waitforwm
+Waits for a WM_NET compatible windowmanager
+.TP
+.B \-\-style <style>
+sets the application GUI style
+.TP
+.B \-\-geometry <geometry>
+sets the client geometry of the main widget \- see man X for the
+argument format
+.TP
+.B \-\-nofork
+Don't run in the background.
+
+.SH FILES
+.TP
+.I ~/.trinity/share/config/krecipesrc
+.B Krecipes
+configuration file
+.SH SEE ALSO
+Full user documentation is available through the TDE Help Center. You
+can also enter the URL
+.BR help:/krecipes/
+directly into konqueror or you can run
+.BR "khelpcenter help:/krecipes/"
+from the command\-line.
+
+.SH AUTHORS
+.nf
+Jason Kivlighn <[email protected]>
+.br
+Unai Garro <[email protected]>
+.br
+Cyril Bosselut <[email protected]>
+.br
+.fi
+Please use http://bugs.trinitydesktop.org to report bugs; do not mail the authors
+directly.
+.PP
+This manual page was written by Matthias Julius <[email protected]>,
+for the Debian project (and may be used by others). Permission is
+granted to copy, distribute and/or modify this document under the
+terms of the GNU General Public License, Version 2 or any later
+version published by the Free Software Foundation.
+.PP
+On Debian systems, the complete text of the GNU General Public License
+version 2 can be found in /usr/share/common\-licenses/GPL\-2.