cvsroot/root-tail/root-tail.man

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