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