2 '\" Copyright (c) 1999 Victor B. Wagner
5 '\" RCS: @(#) $Id: syslog.n,v 1.1 2006-02-24 14:11:33 vitus Exp $
7 '\" The definitions below are for supplemental macros used in Tcl/Tk
10 '\" .AP type name in/out ?indent?
11 '\" Start paragraph describing an argument to a library procedure.
12 '\" type is type of argument (int, etc.), in/out is either "in", "out",
13 '\" or "in/out" to describe whether procedure reads or modifies arg,
14 '\" and indent is equivalent to second arg of .IP (shouldn't ever be
15 '\" needed; use .AS below instead)
18 '\" Give maximum sizes of arguments for setting tab stops. Type and
19 '\" name are examples of largest possible arguments that will be passed
20 '\" to .AP later. If args are omitted, default tab stops are used.
23 '\" Start box enclosure. From here until next .BE, everything will be
24 '\" enclosed in one large box.
27 '\" End of box enclosure.
30 '\" Begin code excerpt.
35 '\" .VS ?version? ?br?
36 '\" Begin vertical sidebar, for use in marking newly-changed parts
37 '\" of man pages. The first argument is ignored and used for recording
38 '\" the version when the .VS was added, so that the sidebars can be
39 '\" found and removed when they reach a certain age. If another argument
40 '\" is present, then a line break is forced before starting the sidebar.
43 '\" End of vertical sidebar.
46 '\" Begin an indented unfilled display.
49 '\" End of indented unfilled display.
52 '\" Start of list of standard options for a Tk widget. The
53 '\" options follow on successive lines, in four columns separated
57 '\" End of list of standard options for a Tk widget.
59 '\" .OP cmdName dbName dbClass
60 '\" Start of description of a specific option. cmdName gives the
61 '\" option's name as specified in the class command, dbName gives
62 '\" the option's name in the option database, and dbClass gives
63 '\" the option's class in the option database.
66 '\" Print arg1 underlined, then print arg2 normally.
68 '\" RCS: @(#) $Id: syslog.n,v 1.1 2006-02-24 14:11:33 vitus Exp $
70 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
74 '\" # Start an argument description
78 . ie !"\\$2"" .TP \\n()Cu
83 \&\\$1 \\fI\\$2\\fP (\\$3)
96 '\" # define tabbing values for .AP
99 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
102 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
103 .nr )C \\n()Bu+\\w'(in/out)'u+2n
105 .AS Tcl_Interp Tcl_CreateInterp in/out
106 '\" # BS - start boxed text
107 '\" # ^y = starting y location
115 .if n \l'\\n(.lu\(ul'
118 '\" # BE - end boxed text (draw box now)
123 .ie n \l'\\n(^lu\(ul'
125 .\" Draw four-sided box normally, but don't draw top of
126 .\" box if the box started on an earlier page.
128 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
131 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
138 '\" # VS - start vertical sidebar
139 '\" # ^Y = starting y location
140 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
144 .ie n 'mc \s12\(br\s0
147 '\" # VE - end of vertical sidebar
155 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
162 '\" # Special macro to handle page bottom: finish off current
163 '\" # box/sidebar if in box/sidebar mode, then invoked standard
164 '\" # page bottom macro.
171 .\" Draw three-sided box if this is the box's first page,
172 .\" draw two sides but no top otherwise.
173 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
174 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
177 .nr ^x \\n(^tu+1v-\\n(^Yu
178 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
191 '\" # DS - begin display
197 '\" # DE - end display
203 '\" # SO - start of list of standard options
205 .SH "STANDARD OPTIONS"
211 '\" # SE - end of list of standard options
216 See the \\fBoptions\\fR manual entry for details on the standard options.
218 '\" # OP - start of full description for a single option
223 Command-Line Name: \\fB\\$1\\fR
224 Database Name: \\fB\\$2\\fR
225 Database Class: \\fB\\$3\\fR
229 '\" # CS - begin code excerpt
235 '\" # CE - end code excerpt
243 .TH syslog n 2.0 Tcl "Tcl Syslog extension"
245 '\" Note: do not modify the .SH NAME line immediately below!
247 syslog \- send message to syslog from Tcl script
249 \fBpackage require Syslog\fR
251 \fBsyslog \fR?\fIoptions\fR? \fIpriority\fR \fImessage\fR
256 This command sends \fImessage\fR to system syslog facility
257 with given \fIpriority\fR. Valid priorities are:
259 \fBemerg\fR, \fBalert\fR, \fBcrit\fR, \fBerr\fR, \fBerror\fR, \fBwarning\fR, \fBnotice\fR, \fBinfo\fR, \fBdebug\fR.
262 By default, facility \fBuser\fR is used and value of tcl variable
263 \fBargv0\fR is used as ident string.
264 However, any of the following options may be
265 specified before \fIpriority\fR to control these parameters:
267 \fB\-facility\fR \fIvalue\fR
268 Use specified facility instead of \fBuser\fR. Following facility are
271 \fBauthpriv\fR, \fBcron\fR, \fBdaemon\fR, \fBkernel\fR, \fBlpr\fR,
272 \fBmail\fR, \fBnews\fR, \fBsyslog\fR, \fBuser\fR, \fBuucp\fR, \fBlocal0\fR,
273 \fBlocal1\fR, \fBlocal2\fR.
275 \fB\-ident\fR \fIstring\fR
276 Use given \fIstring\fR instead of \fBargv0\fB variable for ident string.
278 \fB\-options\fR \fIinteger\fR
279 Set syslog options such as \fBLOG_CONS\fR, \fBLOG_NDELAY\fR
280 You should user numeric values of those from your system \fBsyslog.h\fR
281 file, becouse I haven't got time to implement yet another hash table.