as-events.5@c920180c879a
as-events.5
Fri, 05 Dec 2008 23:15:28 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Fri, 05 Dec 2008 23:15:28 +0100
- changeset 4
- c920180c879a
- permissions
- -rw-r--r--
Correct version number and date in documentation.
1 .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. | will give a
29 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
32 .tr \(*W-|\(bv\*(Tr
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 . ds -- \(*W-
36 . ds PI pi
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39 . ds L" ""
40 . ds R" ""
41 . ds C`
42 . ds C'
43 'br\}
44 .el\{\
45 . ds -- \|\(em\|
46 . ds PI \(*p
47 . ds L" ``
48 . ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 . de IX
57 . tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 . nr % 0
60 . rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
71 .if n \{\
72 . ds #H 0
73 . ds #V .8m
74 . ds #F .3m
75 . ds #[ \f1
76 . ds #] \fP
77 .\}
78 .if t \{\
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 . ds #V .6m
81 . ds #F 0
82 . ds #[ \&
83 . ds #] \&
84 .\}
85 . \" simple accents for nroff and troff
86 .if n \{\
87 . ds ' \&
88 . ds ` \&
89 . ds ^ \&
90 . ds , \&
91 . ds ~ ~
92 . ds /
93 .\}
94 .if t \{\
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 . ds : e
119 . ds 8 ss
120 . ds o a
121 . ds d- d\h'-1'\(ga
122 . ds D- D\h'-1'\(hy
123 . ds th \o'bp'
124 . ds Th \o'LP'
125 . ds ae ae
126 . ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "AS-EVENTS 5"
132 .TH AS-EVENTS 5 "as-gui 0.7.2" "06-Mar-2003" "AS Events File"
133 .SH "NAME"
134 \&\fBas\-events\fR \- accounting system events document format
135 .SH "DESCRIPTION"
136 .IX Header "DESCRIPTION"
137 The \fBas-gui\fR application takes input from the user and may store its data to
138 a file on the local filesystem. Among other functions, a user can enter time,
139 amounts, remarks, and other values. This data tuple is termed an \fIevent\fR, and
140 may either be transmitted to a \fB\s-1AS\s0\fR server or stored to a local file. Should
141 it be stored to a local file, the file name is arbitrary and is shown in the
142 title bar of \fBas-gui\fR. Typically, the file is called \fIevents.as\fR. In most
143 cases the postfix \fB.as\fR is appended to the file name, although this behaviour
144 can be turned on or off through the user preferences.
145 .SH "FILE FORMAT"
146 .IX Header "FILE FORMAT"
147 The \fBas-events\fR file contains \s-1ASCII\s0 text. The first line consists of an
148 identifier to associate the file type and version. Following text may contain
149 white space, comments, and data tuples.
150 .SH "GRAMMAR"
151 .IX Header "GRAMMAR"
152 \&\fBevents.as\fR ::= \fBeventsid\fR \fBtuplelist\fR
153 .PP
154 \&\fBeventsid\fR ::= \*(L"%!AS\-EVENTS\-\*(R" [0\-9] '.' [0\-9]
155 .PP
156 \&\fBtuplelist\fR ::= \fBtuplelist\fR | \fBtuple\fR | \fBcomment\fR | \s-1EMPTY\s0
157 .PP
158 \&\fBtuple\fR ::= \fBuser\fR \fBuuid\fR \fBcrc\fR \fBrevision\fR \fBdate\fR \fBbegin\fR \fBend\fR \fBamount\fR \fBaccount\fR \fBremark\fR
159 .PP
160 \&\fBcomment\fR ::= ($#.*)
161 .PP
162 (* user field *)
163 .PP
164 \&\fBuser\fR ::= [a\-zA\-Z][a\-zA\-Z0\-9]+
165 .PP
166 (* uuid field *)
167 .PP
168 \&\fBuuid\fR ::= \fBhexoctet\fR '\-' \fBhexquartet\fR '\-' \fBhexquartet\fR '\-' \fBhexquartet\fR '\-' \fBhextwelvetet\fR
169 .PP
170 (* crc field *)
171 .PP
172 \&\fBcrc\fR ::= \fBhexoctet\fR
173 .PP
174 \&\fBhextwelvetet\fR ::= \fBhexoctet\fR | \fBhexquartet\fR
175 .PP
176 \&\fBhexoctet\fR ::= \fBhexquartet\fR | \fBhexquartet\fR
177 .PP
178 \&\fBhexquartet\fR ::= \fBhexdigit\fR | \fBhexdigit\fR | \fBhexdigit\fR | \fBhexdigit\fR
179 .PP
180 \&\fBhexdigit\fR ::= \fBa\-zA\-Z0\-9\fR
181 .PP
182 (* revision field *)
183 .PP
184 \&\fBrevision\fR ::= [0\-9]
185 .PP
186 (* date field *)
187 .PP
188 \&\fBdate\fR ::= [0\-9][0\-9][0\-9][0\-9] '\-' [01][0\-9] '\-' [0123][0\-9]
189 .PP
190 (* time fields *)
191 .PP
192 \&\fBbegin\fR ::= \fBtimeval\fR
193 .PP
194 \&\fBend\fR ::= \fBendval\fR
195 .PP
196 \&\fBamount\fR ::= \fBtimeval\fR
197 .PP
198 \&\fBtimeval\fR ::= \fBhourval\fR ':' \fBminuteval\fR
199 .PP
200 \&\fBendval\fR ::= \fBhourinc\fR ':' \fBminuteval\fR
201 .PP
202 \&\fBhourval\fR ::= [01][0\-9]
203 .PP
204 \&\fBhourinc\fR ::= \fBhourval\fR | 2[0\-4]
205 .PP
206 \&\fBminval\fR ::= [0\-5][0\-9]
207 .PP
208 (* account field *)
209 .PP
210 \&\fBaccount\fR ::= \fBaccount\fR | \fBaccpart\fR
211 .PP
212 \&\fBaccpart\fR ::= \fBaccsep\fR \fBacctext\fR
213 .PP
214 \&\fBaccsep\fR ::= '/'
215 .PP
216 \&\fBacctext\fR ::= [a\-zA\-Z0\-9_\-]*
217 .PP
218 (* remark field *)
219 .PP
220 \&\fBremark\fR ::= '\*(L"' .* '\*(R"'
221 .SH "EXAMPLE"
222 .IX Header "EXAMPLE"
223 A typical \fBas-events\fR file might look like this:
224 .PP
225 %!AS\-EVENTS\-0.6
226 harvey 0ccf1d42\-743b\-43df\-9b5d\-202451b3c26f e8f212b6 0 2002\-09\-30 00:00 00:00 02:00 /it/development/meeting/weekly \*(L"Code review\*(R"
227 harvey 9c497382\-ae88\-4a1a\-91b5\-202451b3c26f c8637e9a 0 2002\-09\-30 00:00 00:00 00:30 /it/common/office/communication \*(L"Conference call\*(R"
228 harvey e230eae7\-367f\-4c35\-bee1\-202451b3c26f 02cb1abb 0 2002\-09\-30 00:00 00:00 00:30 /sales/travel/customer \*(L"Simontech visit\*(R"
229 .SH "SEE ALSO"
230 .IX Header "SEE ALSO"
231 \&\fIas\-gui\fR\|(1),
232 \&\fIas\-gui.conf\fR\|(5),
233 \&\fIas\-accounts\fR\|(5),
