Update upstream source from tag 'upstream/3.1.1'
[xfishtank.git] / xfishtank.1.tmpl
1 .\"
2 .\" xfishtank.man
3 .\"
4 .\" ##
5 .\"
6 .\" Copyright (c) 1988-92 (xfishtank)
7 .\" Jonathan Greenblatt
8 .\" Dave Lemke
9 .\" Eric Bina
10 .\" Copyright (c) 2021
11 .\" Willem Vermin
12 .\"
13 .\" All Rights Reserved
14 .\"
15 .\" Permission to use, copy, modify, and distribute this software and
16 .\" its documentation for any purpose and without fee is hereby granted,
17 .\" provided that the above copyright notice appear in all copies and
18 .\" that both that copyright notice and this permission notice appear in
19 .\" supporting documentation, and that the name of the author not be
20 .\" used in advertising or publicity pertaining to distribution of the
21 .\" software without specific, written prior permission.
22 .\"
23 .\" This program is distributed in the hope that it will be "playable",
24 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
25 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
26 .\"
27 .TH XFISHTANK 1 "DATE" "VERSION"
28 .SH NAME
29 xfishtank \- Fish swimming across your Root Window
30 .SH SYNOPSIS
31 .B xfishtank
32 [\-c <color>] [\-b <limit>] [\-f <limit>] [\-i <mult>] [\-r <rate>] [\-m <num>]
33 [\-C <num>] [\-d] [\-p <file>] [host:display]
34 .SH DESCRIPTION
35 .LP
36 xfishtank is a animation program to simulate an Aquarium on your X desktop.
37 .SH OPTIONS
38 .TP 8
39 .B \-b \fInumber\fP
40 Number of bubbles (Default: 32)
41 .TP 8
42 .B \-f \fIlimit\fP
43 Number of fishes (Default: 10)
44 .TP 8
45 .B \-bc \fIcolor\fP
46 Color of bubbles (Default: lightblue)
47 .TP 8
48 .B \-double \fIn\fP
49 n=1: Use double buffering, n=0: do not use double buffering (Default: 1)
50 .TP 8
51 .B \-speed \fInumber\fP
52 Speed of fishes (Default: 100)
53 .TP 8
54 .B \-defaults
55 Use default options
56 .TP 8
57 .B \-nomenu
58 Do not show interactive menu
59 .TP 8
60 .B \-display \fIDISPLAY\fP
61 Use this display to draw in (Default:"")
62 .TP 8
63 .B \-root
64 Use root-window or xscreensaver-provided window to draw in
65 .TP 8
66 .B \-window-id \fIwindow\fP
67 Use this window to draw in
68 .TP 8
69 .B \-h
70 Show usage information
71 .TP 8
72 .B \-changelog
73 Show ChangeLog and exit
74 .TP 8
75 .B \-selfrep
76 Output gzipped tar file of the source and exit
77 .SH FILES
78 .br
79 .TP 8
80 \fB$HOME/.xfishtankrc\fR
81 Settings are read from and written to this file.
82 .SH SEE ALSO
83 .LP
84 X(1), xsetroot(1x), xsnow(6), xroach(1), xroachng(1), xpenguins(1)
85 .SH AUTHORS
86 Eric Bina, <\fIebina@ncsa.uiuc.edu\fP> (Original author)
87 .LP
88 Dave Black, <\fIdlbb0@amdahl.com\fP> (Linux port)
89 .LP
90 TJ Phan, <\fIphan@aur.alcatel.com\fP> (TrueColor Support)
91 .LP
92 Vincent Renardias <\fIvincent@waw.com\fP> (man page, Debian packaging)
93 .LP
94 Willem Vermin (adaption to modern desktops / double buffering)
This page took 0.023756 seconds and 4 git commands to generate.