1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/as-events.5 Fri Nov 28 11:21:08 2008 +0100
1.3 @@ -0,0 +1,233 @@
1.4 +.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
1.5 +.\"
1.6 +.\" Standard preamble:
1.7 +.\" ========================================================================
1.8 +.de Sh \" Subsection heading
1.9 +.br
1.10 +.if t .Sp
1.11 +.ne 5
1.12 +.PP
1.13 +\fB\\$1\fR
1.14 +.PP
1.15 +..
1.16 +.de Sp \" Vertical space (when we can't use .PP)
1.17 +.if t .sp .5v
1.18 +.if n .sp
1.19 +..
1.20 +.de Vb \" Begin verbatim text
1.21 +.ft CW
1.22 +.nf
1.23 +.ne \\$1
1.24 +..
1.25 +.de Ve \" End verbatim text
1.26 +.ft R
1.27 +.fi
1.28 +..
1.29 +.\" Set up some character translations and predefined strings. \*(-- will
1.30 +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
1.31 +.\" double quote, and \*(R" will give a right double quote. | will give a
1.32 +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
1.33 +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
1.34 +.\" expand to `' in nroff, nothing in troff, for use with C<>.
1.35 +.tr \(*W-|\(bv\*(Tr
1.36 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
1.37 +.ie n \{\
1.38 +. ds -- \(*W-
1.39 +. ds PI pi
1.40 +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
1.41 +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
1.42 +. ds L" ""
1.43 +. ds R" ""
1.44 +. ds C`
1.45 +. ds C'
1.46 +'br\}
1.47 +.el\{\
1.48 +. ds -- \|\(em\|
1.49 +. ds PI \(*p
1.50 +. ds L" ``
1.51 +. ds R" ''
1.52 +'br\}
1.53 +.\"
1.54 +.\" If the F register is turned on, we'll generate index entries on stderr for
1.55 +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
1.56 +.\" entries marked with X<> in POD. Of course, you'll have to process the
1.57 +.\" output yourself in some meaningful fashion.
1.58 +.if \nF \{\
1.59 +. de IX
1.60 +. tm Index:\\$1\t\\n%\t"\\$2"
1.61 +..
1.62 +. nr % 0
1.63 +. rr F
1.64 +.\}
1.65 +.\"
1.66 +.\" For nroff, turn off justification. Always turn off hyphenation; it makes
1.67 +.\" way too many mistakes in technical documents.
1.68 +.hy 0
1.69 +.if n .na
1.70 +.\"
1.71 +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
1.72 +.\" Fear. Run. Save yourself. No user-serviceable parts.
1.73 +. \" fudge factors for nroff and troff
1.74 +.if n \{\
1.75 +. ds #H 0
1.76 +. ds #V .8m
1.77 +. ds #F .3m
1.78 +. ds #[ \f1
1.79 +. ds #] \fP
1.80 +.\}
1.81 +.if t \{\
1.82 +. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
1.83 +. ds #V .6m
1.84 +. ds #F 0
1.85 +. ds #[ \&
1.86 +. ds #] \&
1.87 +.\}
1.88 +. \" simple accents for nroff and troff
1.89 +.if n \{\
1.90 +. ds ' \&
1.91 +. ds ` \&
1.92 +. ds ^ \&
1.93 +. ds , \&
1.94 +. ds ~ ~
1.95 +. ds /
1.96 +.\}
1.97 +.if t \{\
1.98 +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
1.99 +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
1.100 +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
1.101 +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
1.102 +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
1.103 +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
1.104 +.\}
1.105 +. \" troff and (daisy-wheel) nroff accents
1.106 +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
1.107 +.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
1.108 +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
1.109 +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
1.110 +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
1.111 +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
1.112 +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
1.113 +.ds ae a\h'-(\w'a'u*4/10)'e
1.114 +.ds Ae A\h'-(\w'A'u*4/10)'E
1.115 +. \" corrections for vroff
1.116 +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
1.117 +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
1.118 +. \" for low resolution devices (crt and lpr)
1.119 +.if \n(.H>23 .if \n(.V>19 \
1.120 +\{\
1.121 +. ds : e
1.122 +. ds 8 ss
1.123 +. ds o a
1.124 +. ds d- d\h'-1'\(ga
1.125 +. ds D- D\h'-1'\(hy
1.126 +. ds th \o'bp'
1.127 +. ds Th \o'LP'
1.128 +. ds ae ae
1.129 +. ds Ae AE
1.130 +.\}
1.131 +.rm #[ #] #H #V #F C
1.132 +.\" ========================================================================
1.133 +.\"
1.134 +.IX Title "AS-EVENTS 5"
1.135 +.TH AS-EVENTS 5 "as-gui 0.7.2" "06-Mar-2003" "AS Events File"
1.136 +.SH "NAME"
1.137 +\&\fBas\-events\fR \- accounting system events document format
1.138 +.SH "DESCRIPTION"
1.139 +.IX Header "DESCRIPTION"
1.140 +The \fBas-gui\fR application takes input from the user and may store its data to
1.141 +a file on the local filesystem. Among other functions, a user can enter time,
1.142 +amounts, remarks, and other values. This data tuple is termed an \fIevent\fR, and
1.143 +may either be transmitted to a \fB\s-1AS\s0\fR server or stored to a local file. Should
1.144 +it be stored to a local file, the file name is arbitrary and is shown in the
1.145 +title bar of \fBas-gui\fR. Typically, the file is called \fIevents.as\fR. In most
1.146 +cases the postfix \fB.as\fR is appended to the file name, although this behaviour
1.147 +can be turned on or off through the user preferences.
1.148 +.SH "FILE FORMAT"
1.149 +.IX Header "FILE FORMAT"
1.150 +The \fBas-events\fR file contains \s-1ASCII\s0 text. The first line consists of an
1.151 +identifier to associate the file type and version. Following text may contain
1.152 +white space, comments, and data tuples.
1.153 +.SH "GRAMMAR"
1.154 +.IX Header "GRAMMAR"
1.155 +\&\fBevents.as\fR ::= \fBeventsid\fR \fBtuplelist\fR
1.156 +.PP
1.157 +\&\fBeventsid\fR ::= \*(L"%!AS\-EVENTS\-\*(R" [0\-9] '.' [0\-9]
1.158 +.PP
1.159 +\&\fBtuplelist\fR ::= \fBtuplelist\fR | \fBtuple\fR | \fBcomment\fR | \s-1EMPTY\s0
1.160 +.PP
1.161 +\&\fBtuple\fR ::= \fBuser\fR \fBuuid\fR \fBcrc\fR \fBrevision\fR \fBdate\fR \fBbegin\fR \fBend\fR \fBamount\fR \fBaccount\fR \fBremark\fR
1.162 +.PP
1.163 +\&\fBcomment\fR ::= ($#.*)
1.164 +.PP
1.165 +(* user field *)
1.166 +.PP
1.167 +\&\fBuser\fR ::= [a\-zA\-Z][a\-zA\-Z0\-9]+
1.168 +.PP
1.169 +(* uuid field *)
1.170 +.PP
1.171 +\&\fBuuid\fR ::= \fBhexoctet\fR '\-' \fBhexquartet\fR '\-' \fBhexquartet\fR '\-' \fBhexquartet\fR '\-' \fBhextwelvetet\fR
1.172 +.PP
1.173 +(* crc field *)
1.174 +.PP
1.175 +\&\fBcrc\fR ::= \fBhexoctet\fR
1.176 +.PP
1.177 +\&\fBhextwelvetet\fR ::= \fBhexoctet\fR | \fBhexquartet\fR
1.178 +.PP
1.179 +\&\fBhexoctet\fR ::= \fBhexquartet\fR | \fBhexquartet\fR
1.180 +.PP
1.181 +\&\fBhexquartet\fR ::= \fBhexdigit\fR | \fBhexdigit\fR | \fBhexdigit\fR | \fBhexdigit\fR
1.182 +.PP
1.183 +\&\fBhexdigit\fR ::= \fBa\-zA\-Z0\-9\fR
1.184 +.PP
1.185 +(* revision field *)
1.186 +.PP
1.187 +\&\fBrevision\fR ::= [0\-9]
1.188 +.PP
1.189 +(* date field *)
1.190 +.PP
1.191 +\&\fBdate\fR ::= [0\-9][0\-9][0\-9][0\-9] '\-' [01][0\-9] '\-' [0123][0\-9]
1.192 +.PP
1.193 +(* time fields *)
1.194 +.PP
1.195 +\&\fBbegin\fR ::= \fBtimeval\fR
1.196 +.PP
1.197 +\&\fBend\fR ::= \fBendval\fR
1.198 +.PP
1.199 +\&\fBamount\fR ::= \fBtimeval\fR
1.200 +.PP
1.201 +\&\fBtimeval\fR ::= \fBhourval\fR ':' \fBminuteval\fR
1.202 +.PP
1.203 +\&\fBendval\fR ::= \fBhourinc\fR ':' \fBminuteval\fR
1.204 +.PP
1.205 +\&\fBhourval\fR ::= [01][0\-9]
1.206 +.PP
1.207 +\&\fBhourinc\fR ::= \fBhourval\fR | 2[0\-4]
1.208 +.PP
1.209 +\&\fBminval\fR ::= [0\-5][0\-9]
1.210 +.PP
1.211 +(* account field *)
1.212 +.PP
1.213 +\&\fBaccount\fR ::= \fBaccount\fR | \fBaccpart\fR
1.214 +.PP
1.215 +\&\fBaccpart\fR ::= \fBaccsep\fR \fBacctext\fR
1.216 +.PP
1.217 +\&\fBaccsep\fR ::= '/'
1.218 +.PP
1.219 +\&\fBacctext\fR ::= [a\-zA\-Z0\-9_\-]*
1.220 +.PP
1.221 +(* remark field *)
1.222 +.PP
1.223 +\&\fBremark\fR ::= '\*(L"' .* '\*(R"'
1.224 +.SH "EXAMPLE"
1.225 +.IX Header "EXAMPLE"
1.226 +A typical \fBas-events\fR file might look like this:
1.227 +.PP
1.228 +%!AS\-EVENTS\-0.6
1.229 +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"
1.230 +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"
1.231 +harvey e230eae7\-367f\-4c35\-bee1\-202451b3c26f 02cb1abb 0 2002\-09\-30 00:00 00:00 00:30 /sales/travel/customer \*(L"Simontech visit\*(R"
1.232 +.SH "SEE ALSO"
1.233 +.IX Header "SEE ALSO"
1.234 +\&\fIas\-gui\fR\|(1),
1.235 +\&\fIas\-gui.conf\fR\|(5),
1.236 +\&\fIas\-accounts\fR\|(5),
