cvsroot/root-tail/root-tail.man

.TH ROOTTAIL 1 "2004-03-27" "Version 1.0"
.UC 5
.SH NAME
root-tail \- print text directly to X11 root window
.SH SYNOPSIS
.B root-tail
.RB [ \-g \|| --geometry
.IR GEOMETRY ]
.RB [ \-fn \|| --font
.IR FONTSPEC ]
.RB [ \--color
.IR color ]
.RB [ \--reload
.IR SEC
.IR COMMAND ]
.RB [ \--shade ]
.RB [ \--outline ]
.RB [ \--noflicker ]
.RB [ \-f \|| \--fork ]
.RB [ \--reverse ]
.RB [ \--whole ]
.RB [ \--partial ]
.RB [ \--update ]
.RB [ \--cont
.IR STRING ]
.RB [ \--wordwrap ]
.RB [ \--justify ]
.RB [ \--noinitial ]
.RB [ \--frame ]
.RB [ \-id
.IR ID ]
.RB [ \-i \|| \--interval
.IR SECONDS ]
.RB [ \-V ]
file1[,color[,desc]]
[file2[,color[,desc]]]
.\" Die Beschreibung
.SH DESCRIPTION
Displays a given file anywhere on your X11 root window with a transparent
background. It was made because I'm very lazy and this was easier than
making a new rxvt pixmap each time I changed my background to simulate
that transparent effect. A null desc (example: "/var/log/messages,red,")
will prevent the printing of a description and the []'s.
.PP
.SS General Options
.TP
.BI \--color " COLOR"
Use COLOR as default.
.TP
.BI "\--font \|| -fn" " FONTSPEC"
Use font FONTSPEC. This can be either a fixed width font like \fB-fn\fI
fixed\fR or any font using \fB-fn \fR'\fI-*-*-*-*-*-*-*-*-*-*-*-*-*-*\fR' with
the appropriate fields filled out (see xfontsel).
.TP
.B -f \|| \--fork
Forks to the background.
.TP
.B \--reverse
Display the files in reverse order, with the newest lines at the top.
.TP
.B \--whole
Only display whole lines. If the last line of a file doesn't yet end
with a newline character then wait until it does before displaying
it. This is the default if more than one file is being displayed.
.TP
.B \--partial
This is the opposite of the \fB--whole\fR option (see above). It displays
lines even if they don't yet have a newline at the end. This is the
default if only one file is being displayed.
.TP
.B \--update
Update partial lines 'in place' if they are still on the screen when
they are updated in their files. Using \fB--update\fR automatically turns on
\fB--partial\fR.
.TP
.BI \--cont " STRING"
When partial lines are broken into two lines in the display, prefix
the 2nd line with STRING. Defaults to "\fI|| \fR". Specify the "\fB--whole\fR"
argument to ensure partial lines are never displayed, or specify "\fB--update\fR"
to attempt to "repair" broken lines in-place.
.TP
.BI \--cont-color " COLOR"
Use COLOR when displaying the continuation string (as optionally
specified with the \fB--cont\fR option above).
.TP
.B \--wordwrap
The default behaviour is to fit as much as possible onto each line of
output, even if this means splitting a word between one line and the
next. The \fB--wordwrap\fR argument splits lines at spaces if
possible.
.TP
.B \--justify
After wrapping long lines, attempt to justify the text to produce a
smooth right-hand margin.  Implies \fB--wordwrap\fR.
.TP
.BI \--reload " SEC COMMAND"
Re-display the file(s) and run COMMAND every SEC seconds. The
default is to never re-display the file(s).
.TP
.B \--shade
Add black shading to the font.
.TP
.B \--outline
Add a black outline to the font (making redraws quite a bit slower).
.TP
.B \--noflicker
Use slower but flicker-free update.
.TP
.B \--noinitial
Don't display the end of the file(s) initially.
.TP
.BI "\-id" " ID"
Use the given window ID for output instead of the root window.
.TP
.BI "\-i \|| \--interval" " SECONDS"
Use the specified sleeping interval between checks instead of the
default 2.4 seconds. Fractional values are OK.
.TP
.B \-V
Print version information.
.TP
.B \--frame
Surround the selected area with a frame. This is just a debugging tool
and doesn't always work properly. Use it to find the perfect geometry.
.IP
.SH EXAMPLE
.PP
root-tail -g 800x250+100+50 /var/log/messages,green /var/log/secure,red,'ALERT'
.SH BUGS
.PP
\- width must be larger than the longest file-header, otherwise segfaults.
.PP
Should you happen to find any bugs please fix them and send me a diff.
.PP
NOTE: This program was modified by Marc Lehmann <pcg@goof.com>, who
couldn't reach the original author. Please direct bug-reports etc. to
pcg@goof.com.
.PP
http://root-tail.plan9.de/
Revision:	1.13
Committed:	Wed Apr 7 03:54:31 2004 UTC (22 years, 6 months ago) by chris_moore
Content type:	application/x-troff-man
Branch:	MAIN
Changes since 1.12:	+11 -2 lines
Log Message:	new options -justify and -cont-color linked list instead of array
#	User	Rev	Content
1	pcg	1.5	.TH ROOTTAIL 1 "2004-03-27" "Version 1.0"
2	pcg	1.1	.UC 5
3			.SH NAME
4			root-tail \- print text directly to X11 root window
5			.SH SYNOPSIS
6			.B root-tail
7	pcg	1.7	.RB [ \-g \\|\| --geometry
8	pcg	1.1	.IR GEOMETRY ]
9	pcg	1.7	.RB [ \-fn \\|\| --font
10	pcg	1.1	.IR FONTSPEC ]
11	pcg	1.7	.RB [ \--color
12	pcg	1.1	.IR color ]
13	pcg	1.7	.RB [ \--reload
14	pcg	1.1	.IR SEC
15			.IR COMMAND ]
16	pcg	1.7	.RB [ \--shade ]
17			.RB [ \--outline ]
18			.RB [ \--noflicker ]
19			.RB [ \-f \\|\| \--fork ]
20			.RB [ \--reverse ]
21			.RB [ \--whole ]
22			.RB [ \--partial ]
23			.RB [ \--update ]
24			.RB [ \--cont
25	chris_moore	1.3	.IR STRING ]
26	chris_moore	1.9	.RB [ \--wordwrap ]
27	chris_moore	1.13	.RB [ \--justify ]
28	pcg	1.7	.RB [ \--noinitial ]
29			.RB [ \--frame ]
30	chris_moore	1.9	.RB [ \-id
31			.IR ID ]
32	pcg	1.7	.RB [ \-i \\|\| \--interval
33	pcg	1.1	.IR SECONDS ]
34			.RB [ \-V ]
35			file1[,color[,desc]]
36			[file2[,color[,desc]]]
37			.\" Die Beschreibung
38			.SH DESCRIPTION
39			Displays a given file anywhere on your X11 root window with a transparent
40			background. It was made because I'm very lazy and this was easier than
41			making a new rxvt pixmap each time I changed my background to simulate
42	pcg	1.7	that transparent effect. A null desc (example: "/var/log/messages,red,")
43	pcg	1.1	will prevent the printing of a description and the []'s.
44			.PP
45			.SS General Options
46			.TP
47	pcg	1.7	.BI \--color " COLOR"
48	chris_moore	1.13	Use COLOR as default.
49	pcg	1.1	.TP
50	pcg	1.7	.BI "\--font \\|\| -fn" " FONTSPEC"
51	chris_moore	1.8	Use font FONTSPEC. This can be either a fixed width font like \fB-fn\fI
52			fixed\fR or any font using \fB-fn \fR'\fI--------------\fR' with
53			the appropriate fields filled out (see xfontsel).
54	pcg	1.1	.TP
55	pcg	1.7	.B -f \\|\| \--fork
56	pcg	1.12	Forks to the background.
57	chris_moore	1.3	.TP
58	pcg	1.7	.B \--reverse
59	chris_moore	1.3	Display the files in reverse order, with the newest lines at the top.
60			.TP
61	pcg	1.7	.B \--whole
62			Only display whole lines. If the last line of a file doesn't yet end
63	chris_moore	1.3	with a newline character then wait until it does before displaying
64	pcg	1.7	it. This is the default if more than one file is being displayed.
65	chris_moore	1.3	.TP
66	pcg	1.7	.B \--partial
67	chris_moore	1.8	This is the opposite of the \fB--whole\fR option (see above). It displays
68	pcg	1.7	lines even if they don't yet have a newline at the end. This is the
69	chris_moore	1.3	default if only one file is being displayed.
70			.TP
71	pcg	1.7	.B \--update
72	chris_moore	1.3	Update partial lines 'in place' if they are still on the screen when
73	chris_moore	1.8	they are updated in their files. Using \fB--update\fR automatically turns on
74			\fB--partial\fR.
75	chris_moore	1.3	.TP
76	pcg	1.7	.BI \--cont " STRING"
77	chris_moore	1.11	When partial lines are broken into two lines in the display, prefix
78	chris_moore	1.13	the 2nd line with STRING. Defaults to "\fI\|\| \fR". Specify the "\fB--whole\fR"
79	chris_moore	1.11	argument to ensure partial lines are never displayed, or specify "\fB--update\fR"
80			to attempt to "repair" broken lines in-place.
81	pcg	1.1	.TP
82	chris_moore	1.13	.BI \--cont-color " COLOR"
83			Use COLOR when displaying the continuation string (as optionally
84			specified with the \fB--cont\fR option above).
85			.TP
86	chris_moore	1.9	.B \--wordwrap
87			The default behaviour is to fit as much as possible onto each line of
88			output, even if this means splitting a word between one line and the
89	pcg	1.10	next. The \fB--wordwrap\fR argument splits lines at spaces if
90	chris_moore	1.9	possible.
91			.TP
92	chris_moore	1.13	.B \--justify
93			After wrapping long lines, attempt to justify the text to produce a
94			smooth right-hand margin. Implies \fB--wordwrap\fR.
95			.TP
96	pcg	1.7	.BI \--reload " SEC COMMAND"
97			Re-display the file(s) and run COMMAND every SEC seconds. The
98	chris_moore	1.3	default is to never re-display the file(s).
99	pcg	1.1	.TP
100	pcg	1.7	.B \--shade
101	pcg	1.4	Add black shading to the font.
102			.TP
103	pcg	1.7	.B \--outline
104	chris_moore	1.11	Add a black outline to the font (making redraws quite a bit slower).
105	pcg	1.1	.TP
106	pcg	1.7	.B \--noflicker
107	pcg	1.6	Use slower but flicker-free update.
108			.TP
109	pcg	1.7	.B \--noinitial
110	pcg	1.1	Don't display the end of the file(s) initially.
111			.TP
112	pcg	1.2	.BI "\-id" " ID"
113	chris_moore	1.3	Use the given window ID for output instead of the root window.
114	pcg	1.2	.TP
115	pcg	1.7	.BI "\-i \\|\| \--interval" " SECONDS"
116	chris_moore	1.3	Use the specified sleeping interval between checks instead of the
117	pcg	1.4	default 2.4 seconds. Fractional values are OK.
118	pcg	1.1	.TP
119			.B \-V
120			Print version information.
121			.TP
122	pcg	1.7	.B \--frame
123	chris_moore	1.3	Surround the selected area with a frame. This is just a debugging tool
124			and doesn't always work properly. Use it to find the perfect geometry.
125	pcg	1.1	.IP
126			.SH EXAMPLE
127			.PP
128	chris_moore	1.8	root-tail -g 800x250+100+50 /var/log/messages,green /var/log/secure,red,'ALERT'
129	pcg	1.1	.SH BUGS
130			.PP
131			\- width must be larger than the longest file-header, otherwise segfaults.
132			.PP
133			Should you happen to find any bugs please fix them and send me a diff.
134			.PP
135			NOTE: This program was modified by Marc Lehmann <pcg@goof.com>, who
136	chris_moore	1.3	couldn't reach the original author. Please direct bug-reports etc. to
137			pcg@goof.com.
138	pcg	1.1	.PP
139			http://root-tail.plan9.de/