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 writes the PID of the daemon process to
standard output (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"
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 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.11
Committed:	Sun Mar 28 21:50:00 2004 UTC (20 years, 1 month ago) by chris_moore
Content type:	application/x-troff-man
Branch:	MAIN
CVS Tags:	rel-0_95, last_stable
Changes since 1.10:	+8 -7 lines
Log Message:	* empty log message *
#	Content
1	.TH ROOTTAIL 1 "2004-03-27" "Version 1.0"
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 [ \--outline ]
18	.RB [ \--noflicker ]
19	.RB [ \-f \\|\| \--fork ]
20	.RB [ \--reverse ]
21	.RB [ \--whole ]
22	.RB [ \--partial ]
23	.RB [ \--update ]
24	.RB [ \--cont
25	.IR STRING ]
26	.RB [ \--wordwrap ]
27	.RB [ \--noinitial ]
28	.RB [ \--frame ]
29	.RB [ \-id
30	.IR ID ]
31	.RB [ \-i \\|\| \--interval
32	.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	that transparent effect. A null desc (example: "/var/log/messages,red,")
42	will prevent the printing of a description and the []'s.
43	.PP
44	.SS General Options
45	.TP
46	.BI \--color " COLOR"
47	Use color $color as default.
48	.TP
49	.BI "\--font \\|\| -fn" " FONTSPEC"
50	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	.TP
54	.B -f \\|\| \--fork
55	Forks to the background and writes the PID of the daemon process to
56	standard output (useful if root-tail is being called from a script or
57	frontend).
58	.TP
59	.B \--reverse
60	Display the files in reverse order, with the newest lines at the top.
61	.TP
62	.B \--whole
63	Only display whole lines. If the last line of a file doesn't yet end
64	with a newline character then wait until it does before displaying
65	it. This is the default if more than one file is being displayed.
66	.TP
67	.B \--partial
68	This is the opposite of the \fB--whole\fR option (see above). It displays
69	lines even if they don't yet have a newline at the end. This is the
70	default if only one file is being displayed.
71	.TP
72	.B \--update
73	Update partial lines 'in place' if they are still on the screen when
74	they are updated in their files. Using \fB--update\fR automatically turns on
75	\fB--partial\fR.
76	.TP
77	.BI \--cont " STRING"
78	When partial lines are broken into two lines in the display, prefix
79	the 2nd line with STRING. Defaults to "\fI[+]\fR". Specify the "\fB--whole\fR"
80	argument to ensure partial lines are never displayed, or specify "\fB--update\fR"
81	to attempt to "repair" broken lines in-place.
82	.TP
83	.B \--wordwrap
84	The default behaviour is to fit as much as possible onto each line of
85	output, even if this means splitting a word between one line and the
86	next. The \fB--wordwrap\fR argument splits lines at spaces if
87	possible.
88	.TP
89	.BI \--reload " SEC COMMAND"
90	Re-display the file(s) and run COMMAND every SEC seconds. The
91	default is to never re-display the file(s).
92	.TP
93	.B \--shade
94	Add black shading to the font.
95	.TP
96	.B \--outline
97	Add a black outline to the font (making redraws quite a bit slower).
98	.TP
99	.B \--noflicker
100	Use slower but flicker-free update.
101	.TP
102	.B \--noinitial
103	Don't display the end of the file(s) initially.
104	.TP
105	.BI "\-id" " ID"
106	Use the given window ID for output instead of the root window.
107	.TP
108	.BI "\-i \\|\| \--interval" " SECONDS"
109	Use the specified sleeping interval between checks instead of the
110	default 2.4 seconds. Fractional values are OK.
111	.TP
112	.B \-V
113	Print version information.
114	.TP
115	.B \--frame
116	Surround the selected area with a frame. This is just a debugging tool
117	and doesn't always work properly. Use it to find the perfect geometry.
118	.IP
119	.SH EXAMPLE
120	.PP
121	root-tail -g 800x250+100+50 /var/log/messages,green /var/log/secure,red,'ALERT'
122	.SH BUGS
123	.PP
124	\- width must be larger than the longest file-header, otherwise segfaults.
125	.PP
126	Should you happen to find any bugs please fix them and send me a diff.
127	.PP
128	NOTE: This program was modified by Marc Lehmann <pcg@goof.com>, who
129	couldn't reach the original author. Please direct bug-reports etc. to
130	pcg@goof.com.
131	.PP
132	http://root-tail.plan9.de/