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 [ \--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 $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 and gives the pid of itself (useful if root-tail 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 \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"
CURRENTLY BROKEN. 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
.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
.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 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.9
Committed:	Sun Mar 28 03:28:54 2004 UTC (20 years, 2 months ago) by chris_moore
Content type:	application/x-troff-man
Branch:	MAIN
Changes since 1.8:	+9 -1 lines
Log Message:	Added '-wordwrap' option.
#	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	pcg	1.7	.RB [ \--noinitial ]
28			.RB [ \--frame ]
29	chris_moore	1.9	.RB [ \-id
30			.IR ID ]
31	pcg	1.7	.RB [ \-i \\|\| \--interval
32	pcg	1.1	.IR SECONDS ]
33			.RB [ \-V ]
34			file1[,color[,desc]]
35			[file2[,color[,desc]]]
36			.\" Die Beschreibung
37			.SH DESCRIPTION
38			Displays a given file anywhere on your X11 root window with a transparent
39			background. It was made because I'm very lazy and this was easier than
40			making a new rxvt pixmap each time I changed my background to simulate
41	pcg	1.7	that transparent effect. A null desc (example: "/var/log/messages,red,")
42	pcg	1.1	will prevent the printing of a description and the []'s.
43			.PP
44			.SS General Options
45			.TP
46	pcg	1.7	.BI \--color " COLOR"
47	pcg	1.1	Use color $color as default.
48			.TP
49	pcg	1.7	.BI "\--font \\|\| -fn" " FONTSPEC"
50	chris_moore	1.8	Use font FONTSPEC. This can be either a fixed width font like \fB-fn\fI
51			fixed\fR or any font using \fB-fn \fR'\fI--------------\fR' with
52			the appropriate fields filled out (see xfontsel).
53	pcg	1.1	.TP
54	pcg	1.7	.B -f \\|\| \--fork
55	chris_moore	1.8	Forks to the background and gives the pid of itself (useful if root-tail is
56	chris_moore	1.3	being called from a script or frontend)
57			.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			CURRENTLY BROKEN. When partial lines are broken into two lines in the
78	chris_moore	1.8	display, prefix the 2nd line with STRING. Defaults to "\fI[+]\fR". Specify the
79			"\fB--whole\fR" argument to ensure partial lines are never displayed, or specify
80			"\fB--update\fR" to attempt to "repair" broken lines in-place.
81	pcg	1.1	.TP
82	chris_moore	1.9	.B \--wordwrap
83			The default behaviour is to fit as much as possible onto each line of
84			output, even if this means splitting a word between one line and the
85			next. The \fB--wordwrap\fR argument splits lines at spaces if
86			possible.
87			.TP
88	pcg	1.7	.BI \--reload " SEC COMMAND"
89			Re-display the file(s) and run COMMAND every SEC seconds. The
90	chris_moore	1.3	default is to never re-display the file(s).
91	pcg	1.1	.TP
92	pcg	1.7	.B \--shade
93	pcg	1.4	Add black shading to the font.
94			.TP
95	pcg	1.7	.B \--outline
96			Add black outline to the font (making redraws quite a bit slower).
97	pcg	1.1	.TP
98	pcg	1.7	.B \--noflicker
99	pcg	1.6	Use slower but flicker-free update.
100			.TP
101	pcg	1.7	.B \--noinitial
102	pcg	1.1	Don't display the end of the file(s) initially.
103			.TP
104	pcg	1.2	.BI "\-id" " ID"
105	chris_moore	1.3	Use the given window ID for output instead of the root window.
106	pcg	1.2	.TP
107	pcg	1.7	.BI "\-i \\|\| \--interval" " SECONDS"
108	chris_moore	1.3	Use the specified sleeping interval between checks instead of the
109	pcg	1.4	default 2.4 seconds. Fractional values are OK.
110	pcg	1.1	.TP
111			.B \-V
112			Print version information.
113			.TP
114	pcg	1.7	.B \--frame
115	chris_moore	1.3	Surround the selected area with a frame. This is just a debugging tool
116			and doesn't always work properly. Use it to find the perfect geometry.
117	pcg	1.1	.IP
118			.SH EXAMPLE
119			.PP
120	chris_moore	1.8	root-tail -g 800x250+100+50 /var/log/messages,green /var/log/secure,red,'ALERT'
121	pcg	1.1	.SH BUGS
122			.PP
123			\- width must be larger than the longest file-header, otherwise segfaults.
124			.PP
125			Should you happen to find any bugs please fix them and send me a diff.
126			.PP
127			NOTE: This program was modified by Marc Lehmann <pcg@goof.com>, who
128	chris_moore	1.3	couldn't reach the original author. Please direct bug-reports etc. to
129			pcg@goof.com.
130	pcg	1.1	.PP
131			http://root-tail.plan9.de/