/
xcowsay.6
112 lines (105 loc) · 2.84 KB
/
xcowsay.6
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
.\" man page for xcowsay
.TH "xcowsay" 6
.SH NAME
xcowsay \- Display a cute cow and speech bubble.
.SH SYNOPSIS
.B xcowsay
.RB [ "-h" ]
.RB [ "-t"
.RI \| time \|]
.RB [ "-r"
.RI \| speed \|]
.RB [ "-d" ]
.RB [ "-f"
.RI \| font \|]
.RI [\| text \|]...
.SH DESCRIPTION
Display a cow with a speech bubble containing some text. If
.I text
is specified it will be displayed in the bubble. Otherwise the text
will be read from the standard input and displayed when end of file
is encountered.
The cow is displayed for either a fixed amount of time, or an amount
of time calculated from the size of the text. Click on the cow to
dismiss it immediately.
If
.B xcowsay
is started with
.B "--daemon"
it will fork away from the terminal and run in daemon mode. The
daemon provides a DBus service
.B uk.me.doof.Cowsay
that responds to
.B ShowCow
requests. The daemon can queue up any number of requests and displays
them in order.
When
.B xcowsay
starts it checks to see if a daemon is running, and if it is, sends a
.B ShowCow
request and returns immediately. Otherwise
.B xcowsay
will block until the cow has disappeared.
.SH CONFIGURATION FILE
xcowsay reads a configuration file on startup. Currently the file must
be named .xcowsayrc in your home directory, a system-wide config file
might be added in a later release.
The configuration file consists of 'option = value' pairs, one per line. The
valid keys are given in the next section. For example, the following line sets
display time to 10 seconds:
.PP
.RS
display_time = 10000
.RE
.PP
The character '#' begins a comment which lasts until the end of the line.
.SH OPTIONS
Note that these options override any settings in the config file.
.TP
.B "-h, --help"
Display usage information.
.TP
.BI "-t " time ", --time=" time
Display the cow for
.I time
seconds. This overrides any value set for
.IR reading_speed .
The corresponding config file option is
.IR display_time .
.TP
.BI "-r " speed ", --reading-speed=" speed
Number of milliseconds to display the cow for each word in the input
text. This is clamped to a minimum of
.I min_display_time
and a maximum of
.IR max_display_time .
The defaults are 1 second and 30 seconds respectively. The corresponding
config file option is
.IR reading_speed .
.TP
.BI "-f " font ", --font=" font
Font for the speech bubble text. Accepts Pango font strings. The
corresponding config file option is
.IR font .
.TP
.B "-d, --daemon"
Run xcowsay in daemon mode if DBus support has been enabled. See the
description for more information.
.TP
.BI "--cow-size=" size
Size of the cow image. Current choices are
.BR small ", " med ", or " large .
The corresponding config file option is
.IR cow_size .
.TP
.B "--debug"
Print messages about what
.B xcowsay
is doing. Useful for finding out why the daemon fails.
.TP
.B "-v, --version"
Print version information.
.SH "SEE ALSO"
.BR cowsay (6)
.SH BUGS
There are no bugs.