ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/root-tail/root-tail.man.html
Revision: 1.1
Committed: Sun Jun 16 01:24:52 2019 UTC (7 years, 3 months ago) by root
Content type: text/html
Branch: MAIN
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2     <HTML><HEAD><TITLE>Man page of ROOTTAIL</TITLE>
3     </HEAD><BODY>
4     <H1>ROOTTAIL</H1>
5     Section: User Commands (1)<BR>Updated: 2004-03-27<BR><A HREF="#index">Index</A>
6     <A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
7    
8    
9     <A NAME="lbAB">&nbsp;</A>
10     <H2>NAME</H2>
11    
12     root-tail - print text directly to X11 root window
13     <A NAME="lbAC">&nbsp;</A>
14     <H2>SYNOPSIS</H2>
15    
16     <B>root-tail</B>
17    
18     [<B>-g</B>|<B>--geometry</B>
19    
20     <I>GEOMETRY</I>]
21    
22     [<B>-fn</B>|<B>--font</B>
23    
24     <I>FONTSPEC</I>]
25    
26     [<B>--color</B>
27    
28     <I>color</I>]
29    
30     [<B>--reload</B>
31    
32     <I>SEC</I>
33    
34     <I>COMMAND</I>]
35    
36     [<B>--shade</B>]
37    
38     [<B>--outline</B>]
39    
40     [<B>--minspace</B>]
41    
42     [<B>--noflicker</B>]
43    
44     [<B>-f</B>|<B>--fork</B>]
45    
46     [<B>--reverse</B>]
47    
48     [<B>--whole</B>]
49    
50     [<B>--partial</B>]
51    
52     [<B>--update</B>]
53    
54     [<B>--cont</B>
55    
56     <I>STRING</I>]
57    
58     [<B>--wordwrap</B>]
59    
60     [<B>--justify</B>]
61    
62     [<B>--noinitial</B>]
63    
64     [<B>--frame</B>]
65    
66     [<B>--windowed</B>}
67    
68     [<B>-id</B>
69    
70     <I>ID</I>]
71    
72     [<B>-i</B>|<B>--interval</B>
73    
74     <I>SECONDS</I>]
75    
76     [<B>-V</B>]
77    
78     file1[,color[,desc]]
79     [file2[,color[,desc]]]
80    
81     <A NAME="lbAD">&nbsp;</A>
82     <H2>DESCRIPTION</H2>
83    
84     Displays a given file anywhere on your X11 root window, i.e. it is kind of tail -f for multiple files
85     using your desktop background as output window.
86     <P>
87    
88     All non-option arguments on the command line are files to be logged. A
89     null desc (example: &quot;/var/log/messages,red,&quot;) will prevent the printing of
90     a description and the []'s.
91     <P>
92    
93     <A NAME="lbAE">&nbsp;</A>
94     <H3>General Options</H3>
95    
96     <DL COMPACT>
97     <DT><B>--color</B><I> COLOR</I>
98    
99     <DD>
100     Use COLOR as default.
101     <DT><B>--font | -fn</B><I> FONTSPEC</I>
102    
103     <DD>
104     Use font FONTSPEC. This can be either a fixed width font like <B>-fn</B><I>
105     fixed</I> or any font using <B>-fn </B>'<I>-*-*-*-*-*-*-*-*-*-*-*-*-*-*</I>' with
106     the appropriate fields filled out (see xfontsel). Specifying a
107     different FONTSPEC before each filename will cause each file to be
108     displayed in a different font.
109     <DT><B>-f | --fork</B>
110    
111     <DD>
112     Forks to the background.
113     <DT><B>--reverse</B>
114    
115     <DD>
116     Display the files in reverse order, with the newest lines at the top.
117     <DT><B>--whole</B>
118    
119     <DD>
120     Only display whole lines. If the last line of a file doesn't yet end
121     with a newline character then wait until it does before displaying
122     it. This is the default if more than one file is being displayed.
123     <DT><B>--partial</B>
124    
125     <DD>
126     This is the opposite of the <B>--whole</B> option (see above). It displays
127     lines even if they don't yet have a newline at the end. This is the
128     default if only one file is being displayed.
129     <DT><B>--update</B>
130    
131     <DD>
132     Update partial lines 'in place' if they are still on the screen when
133     they are updated in their files. Using <B>--update</B> automatically turns on
134     <B>--partial</B>.
135     <DT><B>--cont</B><I> STRING</I>
136    
137     <DD>
138     When partial lines are broken into two lines in the display, prefix
139     the 2nd line with STRING. Defaults to &quot;<I>|| </I>&quot;. Specify the &quot;<B>--whole</B>&quot;
140     argument to ensure partial lines are never displayed, or specify &quot;<B>--update</B>&quot;
141     to attempt to &quot;repair&quot; broken lines in-place.
142     <DT><B>--cont-color</B><I> COLOR</I>
143    
144     <DD>
145     Use COLOR when displaying the continuation string (as optionally
146     specified with the <B>--cont</B> option above).
147     <DT><B>--wordwrap</B>
148    
149     <DD>
150     The default behaviour is to fit as much as possible onto each line of
151     output, even if this means splitting a word between one line and the
152     next. The <B>--wordwrap</B> argument splits lines at spaces if
153     possible.
154     <DT><B>--justify</B>
155    
156     <DD>
157     After wrapping long lines, attempt to justify the text to produce a
158     smooth right-hand margin. Implies <B>--wordwrap</B>.
159     <DT><B>--reload</B><I> SEC COMMAND</I>
160    
161     <DD>
162     Re-display the file(s) and run COMMAND every SEC seconds. The
163     default is to never re-display the file(s).
164     <DT><B>--shade</B>
165    
166     <DD>
167     Add black shading to the font.
168     <DT><B>--outline</B>
169    
170     <DD>
171     Add a black outline to the font (making redraws quite a bit slower).
172     <DT><B>--minspace</B>
173    
174     <DD>
175     Use minimum linespace even when using shading or outlining. This might result in
176     leftover pixels (dependign on font and logfile content).
177     <DT><B>--noflicker</B>
178    
179     <DD>
180     Use slower but flicker-free update.
181     <DT><B>--noinitial</B>
182    
183     <DD>
184     Don't display the end of the file(s) initially.
185     <DT><B>--windowed</B>
186    
187     <DD>
188     Create a new window instead of reusing the root window. The newly created window
189     covers the whole screen, puts itself behind all other windows and and does not accept
190     events. Use this option if you use a compositing manager suihc as xcompmgr or compton, as
191     the compositing extension has been very badly designed and cannot handle root windows
192     correctly.
193     <DT><B>-id</B><I> ID</I>
194    
195     <DD>
196     Use the given window ID for output instead of the root window.
197     <DT><B>-i | --interval</B><I> SECONDS</I>
198    
199     <DD>
200     Use the specified sleeping interval between checks instead of the
201     default 2.4 seconds. Fractional values are OK.
202     <DT><B>-V</B>
203    
204     <DD>
205     Print version information.
206     <DT><B>--frame</B>
207    
208     <DD>
209     Draw a frame around the selected area. This is useful when trying to
210     find the perfect geometry.
211     <DT><DD>
212     </DL>
213     <A NAME="lbAF">&nbsp;</A>
214     <H2>EXAMPLE</H2>
215    
216     <P>
217    
218     root-tail --windowed -g 800x250+100+50 -font 10x20 /var/log/messages,green -font 12x24 /var/log/secure,red,'ALERT'
219     <A NAME="lbAG">&nbsp;</A>
220     <H2>BUGS</H2>
221    
222     <P>
223    
224     Some desktop environments open a virtual root window and make it difficult to share it. If
225     you cannot see anything after starting root-tail, try to find a setting &quot;allow programs
226     on desktop&quot; or similar, or manually specify a window id.
227     <P>
228    
229     Should you happen to find any bugs please fix them and send me a diff.
230     <P>
231    
232     NOTE: This program was modified by Marc Lehmann &lt;<A HREF="mailto:pcg@goof.com">pcg@goof.com</A>&gt;, who
233     couldn't reach the original author. Please direct bug-reports etc. to
234     <A HREF="mailto:pcg@goof.com">pcg@goof.com</A>.
235     <P>
236    
237     <A HREF="http://root-tail.plan9.de/">http://root-tail.plan9.de/</A>
238     <P>
239    
240     <HR>
241     <A NAME="index">&nbsp;</A><H2>Index</H2>
242     <DL>
243     <DT><A HREF="#lbAB">NAME</A><DD>
244     <DT><A HREF="#lbAC">SYNOPSIS</A><DD>
245     <DT><A HREF="#lbAD">DESCRIPTION</A><DD>
246     <DL>
247     <DT><A HREF="#lbAE">General Options</A><DD>
248     </DL>
249     <DT><A HREF="#lbAF">EXAMPLE</A><DD>
250     <DT><A HREF="#lbAG">BUGS</A><DD>
251     </DL>
252     <HR>
253     This document was created by
254     <A HREF="/cgi-bin/man/man2html">man2html</A>,
255     using the manual pages.<BR>
256     Time: 01:24:48 GMT, June 16, 2019
257     </BODY>
258     </HTML>