ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/root-tail/root-tail.man
(Generate patch)

Comparing root-tail/root-tail.man (file contents):
Revision 1.6 by pcg, Sat Mar 27 21:12:22 2004 UTC vs.
Revision 1.7 by pcg, Sat Mar 27 21:17:50 2004 UTC

2.UC 5 2.UC 5
3.SH NAME 3.SH NAME
4root-tail \- print text directly to X11 root window 4root-tail \- print text directly to X11 root window
5.SH SYNOPSIS 5.SH SYNOPSIS
6.B root-tail 6.B root-tail
7.RB [ \-g \|| -geometry 7.RB [ \-g \|| --geometry
8.IR GEOMETRY ] 8.IR GEOMETRY ]
9.RB [ \-fn \|| -font 9.RB [ \-fn \|| --font
10.IR FONTSPEC ] 10.IR FONTSPEC ]
11.RB [ \-color 11.RB [ \--color
12.IR color ] 12.IR color ]
13.RB [ \-reload 13.RB [ \--reload
14.IR SEC 14.IR SEC
15.IR COMMAND ] 15.IR COMMAND ]
16.RB [ \-shade ] 16.RB [ \--shade ]
17.RB [ \-outline ] 17.RB [ \--outline ]
18.RB [ \-noflicker ] 18.RB [ \--noflicker ]
19.RB [ \-f \|| \-fork ] 19.RB [ \-f \|| \--fork ]
20.RB [ \-reverse ] 20.RB [ \--reverse ]
21.RB [ \-whole ] 21.RB [ \--whole ]
22.RB [ \-partial ] 22.RB [ \--partial ]
23.RB [ \-update ] 23.RB [ \--update ]
24.RB [ \-cont 24.RB [ \--cont
25.IR STRING ] 25.IR STRING ]
26.RB [ \-noinitial ] 26.RB [ \--noinitial ]
27.RB [ \-frame ] 27.RB [ \--frame ]
28.RB [ \-id ID ] 28.RB [ \-id ID ]
29.RB [ \-i \|| \-interval 29.RB [ \-i \|| \--interval
30.IR SECONDS ] 30.IR SECONDS ]
31.RB [ \-V ] 31.RB [ \-V ]
32file1[,color[,desc]] 32file1[,color[,desc]]
33[file2[,color[,desc]]] 33[file2[,color[,desc]]]
34.\" Die Beschreibung 34.\" Die Beschreibung
35.SH DESCRIPTION 35.SH DESCRIPTION
36Displays a given file anywhere on your X11 root window with a transparent 36Displays a given file anywhere on your X11 root window with a transparent
37background. It was made because I'm very lazy and this was easier than 37background. It was made because I'm very lazy and this was easier than
38making a new rxvt pixmap each time I changed my background to simulate 38making a new rxvt pixmap each time I changed my background to simulate
39that transparent effect. A null desc (example: "/var/log/messages,red,") 39that transparent effect. A null desc (example: "/var/log/messages,red,")
40will prevent the printing of a description and the []'s. 40will prevent the printing of a description and the []'s.
41.PP 41.PP
42.SS General Options 42.SS General Options
43.TP 43.TP
44.BI \-color " COLOR" 44.BI \--color " COLOR"
45Use color $color as default. 45Use color $color as default.
46.TP 46.TP
47.BI "\-font \|| -fn" " FONTSPEC" 47.BI "\--font \|| -fn" " FONTSPEC"
48Use font FONTSPEC. This can be either fixed withn fonts like -fn 48Use font FONTSPEC. This can be either fixed withn fonts like -fn
49fixed or any font using -fn '-*-*-*-*-*-*-*-*-*-*-*-*-*-*' with the 49fixed or any font using -fn '-*-*-*-*-*-*-*-*-*-*-*-*-*-*' with the
50appropriate fields filled out (see xfontsel) 50appropriate fields filled out (see xfontsel).
51.TP 51.TP
52.B -f \|| \-fork 52.B -f \|| \--fork
53Forks to the background and gives the pid of itself (useful if rt is 53Forks to the background and gives the pid of itself (useful if rt is
54being called from a script or frontend) 54being called from a script or frontend)
55.TP 55.TP
56.B \-reverse 56.B \--reverse
57Display the files in reverse order, with the newest lines at the top. 57Display the files in reverse order, with the newest lines at the top.
58.TP 58.TP
59.B \-whole 59.B \--whole
60Only display whole lines. If the last line of a file doesn't yet end 60Only display whole lines. If the last line of a file doesn't yet end
61with a newline character then wait until it does before displaying 61with a newline character then wait until it does before displaying
62it. This is the default if more than one file is being displayed. 62it. This is the default if more than one file is being displayed.
63.TP 63.TP
64.B \-partial 64.B \--partial
65This is the opposite of the -whole option (see above). It displays 65This is the opposite of the --whole option (see above). It displays
66lines even if they don't yet have a newline at the end. This is the 66lines even if they don't yet have a newline at the end. This is the
67default if only one file is being displayed. 67default if only one file is being displayed.
68.TP 68.TP
69.B \-update 69.B \--update
70Update partial lines 'in place' if they are still on the screen when 70Update partial lines 'in place' if they are still on the screen when
71they are updated in their files. Using -update automatically turns on 71they are updated in their files. Using --update automatically turns on
72-partial. 72--partial.
73.TP 73.TP
74.BI \-cont " STRING" 74.BI \--cont " STRING"
75When partial lines are broken into two lines in the display, prefix 75CURRENTLY BROKEN. When partial lines are broken into two lines in the
76the 2nd line with STRING. Defaults to "[+]". Specify the "-whole" 76display, prefix the 2nd line with STRING. Defaults to "[+]". Specify the
77argument to ensure partial lines are never displated, or 77"--whole" argument to ensure partial lines are never displayed, or specify
78specify "-update" to attempt to "repair" broken lines in-place. 78"--update" to attempt to "repair" broken lines in-place.
79.TP 79.TP
80.BI \-reload " SEC COMMAND" 80.BI \--reload " SEC COMMAND"
81Re-display the file(s) and run COMMAND every SEC seconds. The 81Re-display the file(s) and run COMMAND every SEC seconds. The
82default is to never re-display the file(s). 82default is to never re-display the file(s).
83.TP 83.TP
84.B \-shade 84.B \--shade
85Add black shading to the font. 85Add black shading to the font.
86.TP 86.TP
87.B \-outline 87.B \--outline
88Add black outline to the font. 88Add black outline to the font (making redraws quite a bit slower).
89.TP 89.TP
90.B \-noflicker 90.B \--noflicker
91Use slower but flicker-free update. 91Use slower but flicker-free update.
92.TP 92.TP
93.B \-noinitial 93.B \--noinitial
94Don't display the end of the file(s) initially. 94Don't display the end of the file(s) initially.
95.TP 95.TP
96.BI "\-id" " ID" 96.BI "\-id" " ID"
97Use the given window ID for output instead of the root window. 97Use the given window ID for output instead of the root window.
98.TP 98.TP
99.BI "\-i \|| \-interval" " SECONDS" 99.BI "\-i \|| \--interval" " SECONDS"
100Use the specified sleeping interval between checks instead of the 100Use the specified sleeping interval between checks instead of the
101default 2.4 seconds. Fractional values are OK. 101default 2.4 seconds. Fractional values are OK.
102.TP 102.TP
103.B \-V 103.B \-V
104Print version information. 104Print version information.
105.TP 105.TP
106.B \-frame 106.B \--frame
107Surround the selected area with a frame. This is just a debugging tool 107Surround the selected area with a frame. This is just a debugging tool
108and doesn't always work properly. Use it to find the perfect geometry. 108and doesn't always work properly. Use it to find the perfect geometry.
109.IP 109.IP
110.SH EXAMPLE 110.SH EXAMPLE
111.PP 111.PP

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines