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 [ \--noinitial ]
.RB [ \--frame ]
.RB [ \-id 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 $color as default.
.TP
.BI "\--font \|| -fn" " FONTSPEC"
Use font FONTSPEC. This can be either fixed withn fonts like -fn
fixed or any font using -fn '-*-*-*-*-*-*-*-*-*-*-*-*-*-*' with the
appropriate fields filled out (see xfontsel).
.TP
.B -f \|| \--fork
Forks to the background and gives the pid of itself (useful if rt is
being called from a script or frontend)
.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 --whole 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 --update automatically turns on
--partial.
.TP
.BI \--cont " STRING"
CURRENTLY BROKEN. When partial lines are broken into two lines in the
display, prefix the 2nd line with STRING. Defaults to "[+]". Specify the
"--whole" argument to ensure partial lines are never displayed, or specify
"--update" to attempt to "repair" broken lines in-place.
.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 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 80x25+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.7
Committed:	Sat Mar 27 21:17:50 2004 UTC (22 years, 6 months ago) by pcg
Content type:	application/x-troff-man
Branch:	MAIN
Changes since 1.6:	+46 -46 lines
Log Message:	* empty log message *
#	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	pcg	1.7	.RB [ \--noinitial ]
27			.RB [ \--frame ]
28	pcg	1.2	.RB [ \-id ID ]
29	pcg	1.7	.RB [ \-i \\|\| \--interval
30	pcg	1.1	.IR SECONDS ]
31			.RB [ \-V ]
32			file1[,color[,desc]]
33			[file2[,color[,desc]]]
34			.\" Die Beschreibung
35			.SH DESCRIPTION
36			Displays a given file anywhere on your X11 root window with a transparent
37			background. It was made because I'm very lazy and this was easier than
38			making a new rxvt pixmap each time I changed my background to simulate
39	pcg	1.7	that transparent effect. A null desc (example: "/var/log/messages,red,")
40	pcg	1.1	will prevent the printing of a description and the []'s.
41			.PP
42			.SS General Options
43			.TP
44	pcg	1.7	.BI \--color " COLOR"
45	pcg	1.1	Use color $color as default.
46			.TP
47	pcg	1.7	.BI "\--font \\|\| -fn" " FONTSPEC"
48			Use font FONTSPEC. This can be either fixed withn fonts like -fn
49	chris_moore	1.3	fixed or any font using -fn '--------------' with the
50	pcg	1.7	appropriate fields filled out (see xfontsel).
51	pcg	1.1	.TP
52	pcg	1.7	.B -f \\|\| \--fork
53	chris_moore	1.3	Forks to the background and gives the pid of itself (useful if rt is
54			being called from a script or frontend)
55			.TP
56	pcg	1.7	.B \--reverse
57	chris_moore	1.3	Display the files in reverse order, with the newest lines at the top.
58			.TP
59	pcg	1.7	.B \--whole
60			Only display whole lines. If the last line of a file doesn't yet end
61	chris_moore	1.3	with a newline character then wait until it does before displaying
62	pcg	1.7	it. This is the default if more than one file is being displayed.
63	chris_moore	1.3	.TP
64	pcg	1.7	.B \--partial
65			This is the opposite of the --whole option (see above). It displays
66			lines even if they don't yet have a newline at the end. This is the
67	chris_moore	1.3	default if only one file is being displayed.
68			.TP
69	pcg	1.7	.B \--update
70	chris_moore	1.3	Update partial lines 'in place' if they are still on the screen when
71	pcg	1.7	they are updated in their files. Using --update automatically turns on
72			--partial.
73	chris_moore	1.3	.TP
74	pcg	1.7	.BI \--cont " STRING"
75			CURRENTLY BROKEN. When partial lines are broken into two lines in the
76			display, prefix the 2nd line with STRING. Defaults to "[+]". Specify the
77			"--whole" argument to ensure partial lines are never displayed, or specify
78			"--update" to attempt to "repair" broken lines in-place.
79	pcg	1.1	.TP
80	pcg	1.7	.BI \--reload " SEC COMMAND"
81			Re-display the file(s) and run COMMAND every SEC seconds. The
82	chris_moore	1.3	default is to never re-display the file(s).
83	pcg	1.1	.TP
84	pcg	1.7	.B \--shade
85	pcg	1.4	Add black shading to the font.
86			.TP
87	pcg	1.7	.B \--outline
88			Add black outline to the font (making redraws quite a bit slower).
89	pcg	1.1	.TP
90	pcg	1.7	.B \--noflicker
91	pcg	1.6	Use slower but flicker-free update.
92			.TP
93	pcg	1.7	.B \--noinitial
94	pcg	1.1	Don't display the end of the file(s) initially.
95			.TP
96	pcg	1.2	.BI "\-id" " ID"
97	chris_moore	1.3	Use the given window ID for output instead of the root window.
98	pcg	1.2	.TP
99	pcg	1.7	.BI "\-i \\|\| \--interval" " SECONDS"
100	chris_moore	1.3	Use the specified sleeping interval between checks instead of the
101	pcg	1.4	default 2.4 seconds. Fractional values are OK.
102	pcg	1.1	.TP
103			.B \-V
104			Print version information.
105			.TP
106	pcg	1.7	.B \--frame
107	chris_moore	1.3	Surround the selected area with a frame. This is just a debugging tool
108			and doesn't always work properly. Use it to find the perfect geometry.
109	pcg	1.1	.IP
110			.SH EXAMPLE
111			.PP
112			root-tail -g 80x25+100+50 /var/log/messages,green /var/log/secure,red,'ALERT'
113			.SH BUGS
114			.PP
115			\- width must be larger than the longest file-header, otherwise segfaults.
116			.PP
117			Should you happen to find any bugs please fix them and send me a diff.
118			.PP
119			NOTE: This program was modified by Marc Lehmann <pcg@goof.com>, who
120	chris_moore	1.3	couldn't reach the original author. Please direct bug-reports etc. to
121			pcg@goof.com.
122	pcg	1.1	.PP
123			http://root-tail.plan9.de/