r2522 - people/synrg/xjig

[Ben Armstrong]

Author: synrg
Date: 2007-04-04 11:26:58 +0000 (Wed, 04 Apr 2007)
New Revision: 2522

Added:
   people/synrg/xjig/xjig-menu.6
Log:
Added a man page

Added: people/synrg/xjig/xjig-menu.6
===================================================================
--- people/synrg/xjig/xjig-menu.6	2007-04-04 11:17:38 UTC (rev 2521)
+++ people/synrg/xjig/xjig-menu.6	2007-04-04 11:26:58 UTC (rev 2522)
@@ -0,0 +1,62 @@
+.TH XJIG-MENU "6" "April 2007" "xjig-menu, version 1.1" "Games"
+.SH NAME
+xjig-menu, \- manual page for xjig-menu, version 1.1
+.SH DESCRIPTION
+xjig\-menu \- front\-end to launch xjig
+.PP
+Usage:
+.IP
+xjig\-menu [\-p|\-\-pieces XxY] [\-s|\-\-scale XxY] [\-d|\-\-directory DIR] [FILENAME]
+.IP
+xjig\-menu \fB\-m\fR|\-\-make [\-p|\-\-pieces XxY] [\-s|\-\-scale XxY] [\-d|\-\-directory DIR] [\-\-desktop\-directory DIR] [FILENAME]
+.IP
+xjig\-menu [\-h|\-\-help]
+.IP
+xjig\-menu [\-u|\-\-usage]
+.IP
+xjig\-menu [\-v|\-\-version]
+.PP
+\fB\-\-pieces\fR XxY             number of pieces to make on the X and Y axes
+.PP
+\fB\-\-scale\fR XxY              scaled image X and Y axis dimensions (default: 640x480)
+.PP
+\fB\-\-directory\fR DIR          directory to search for image files
+.PP
+\fB\-\-desktop\-directory\fR DIR  directory where desktop link will be made (default: $HOME/Desktop)
+.PP
+\fB\-\-make\fR                   make a link to the specified puzzle in the desktop directory and exit
+.PP
+FILENAME                 png, jpeg or ppm image
+.SH EXAMPLES
+.PP
+To make a 5x4 (20 piece) puzzle from scene.jpg
+.IP
+\f(CW$ xjig-menu --pieces 5x4 scene.jpg\fR
+.PP
+To make an 10x5 (50 piece) puzzle, selecting a file from
+the ~/backgrounds directory
+.IP
+\f(CW$ xjig-menu --directory ~/backgrounds --pieces 10x5\fR
+.PP
+To make a desktop link for a puzzle
+.IP
+\f(CW$ xjig-menu --pieces 5x4 scene.jpg --make\fR
+.SH COPYRIGHT
+Copyright \(co 2007 Ben Armstrong <synrg at sanctuary.nslug.ns.ca>
+.PP
+This program 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.
+.PP
+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.
+.PP
+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., 51 Franklin St, Fifth Floor, Boston, MA 02110\-1301 USA
+.PP
+On Debian systems, the complete text of the GNU General Public License
+can be found in /usr/share/common\-licenses/GPL file.