Update upstream source from tag 'upstream/3.1.1'

[xfishtank.git] / xfishtank.1.tmpl

diff --git a/xfishtank.1.tmpl b/xfishtank.1.tmpl
new file mode 100644 (file)
index 0000000..7fbbf3f
--- /dev/null
+++ b/xfishtank.1.tmpl
@@ -0,0 +1,94 @@
+.\"
+.\" xfishtank.man
+.\"
+.\" ##
+.\"
+.\" Copyright (c) 1988-92                 (xfishtank)
+.\"                        Jonathan Greenblatt
+.\"                        Dave Lemke
+.\"                        Eric Bina
+.\" Copyright (c) 2021
+.\"                         Willem Vermin
+.\"
+.\"                   All Rights Reserved
+.\"
+.\" Permission to use, copy, modify, and distribute this software and
+.\" its documentation for any purpose and without fee is hereby granted,
+.\" provided that the above copyright notice appear in all copies and
+.\" that both that copyright notice and this permission notice appear in
+.\" supporting documentation, and that the name of the author not be
+.\" used in advertising or publicity pertaining to distribution of the
+.\" software without specific, written prior permission.
+.\"
+.\" This program is distributed in the hope that it will be "playable",
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+.\"
+.TH XFISHTANK 1 "DATE" "VERSION"
+.SH NAME
+xfishtank \- Fish swimming across your Root Window
+.SH SYNOPSIS
+.B xfishtank
+[\-c <color>] [\-b <limit>] [\-f <limit>] [\-i <mult>] [\-r <rate>] [\-m <num>]
+[\-C <num>] [\-d] [\-p <file>] [host:display]
+.SH DESCRIPTION
+.LP
+xfishtank is a animation program to simulate an Aquarium on your X desktop.
+.SH OPTIONS
+.TP 8
+.B \-b \fInumber\fP
+Number of bubbles (Default: 32)
+.TP 8
+.B \-f \fIlimit\fP
+Number of fishes (Default: 10)
+.TP 8
+.B \-bc \fIcolor\fP
+Color of bubbles (Default: lightblue)
+.TP 8
+.B \-double \fIn\fP
+n=1: Use double buffering, n=0: do not use double buffering (Default: 1)
+.TP 8
+.B \-speed \fInumber\fP
+Speed of fishes (Default: 100)
+.TP 8
+.B \-defaults
+Use default options
+.TP 8
+.B \-nomenu
+Do not show interactive menu
+.TP 8
+.B \-display \fIDISPLAY\fP
+Use this display to draw in (Default:"")
+.TP 8
+.B \-root
+Use root-window or xscreensaver-provided window to draw in
+.TP 8
+.B \-window-id \fIwindow\fP
+Use this window to draw in
+.TP 8
+.B \-h
+Show usage information
+.TP 8
+.B \-changelog
+Show ChangeLog and exit
+.TP 8
+.B \-selfrep
+Output gzipped tar file of the source and exit
+.SH FILES
+.br
+.TP 8
+\fB$HOME/.xfishtankrc\fR
+Settings are read from and written to this file.
+.SH SEE ALSO
+.LP
+X(1), xsetroot(1x), xsnow(6), xroach(1), xroachng(1), xpenguins(1)
+.SH AUTHORS
+Eric Bina, <\fIebina@ncsa.uiuc.edu\fP> (Original author)
+.LP
+Dave Black, <\fIdlbb0@amdahl.com\fP> (Linux port)
+.LP
+TJ Phan, <\fIphan@aur.alcatel.com\fP> (TrueColor Support)
+.LP
+Vincent Renardias <\fIvincent@waw.com\fP> (man page, Debian packaging)
+.LP
+Willem Vermin (adaption to modern desktops / double buffering)