diff -r 27e940e8e5f3 -r d64aaa7d146f as-events.5 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/as-events.5 Fri Nov 28 11:21:08 2008 +0100 @@ -0,0 +1,233 @@ +.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` +. ds C' +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "AS-EVENTS 5" +.TH AS-EVENTS 5 "as-gui 0.7.2" "06-Mar-2003" "AS Events File" +.SH "NAME" +\&\fBas\-events\fR \- accounting system events document format +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The \fBas-gui\fR application takes input from the user and may store its data to +a file on the local filesystem. Among other functions, a user can enter time, +amounts, remarks, and other values. This data tuple is termed an \fIevent\fR, and +may either be transmitted to a \fB\s-1AS\s0\fR server or stored to a local file. Should +it be stored to a local file, the file name is arbitrary and is shown in the +title bar of \fBas-gui\fR. Typically, the file is called \fIevents.as\fR. In most +cases the postfix \fB.as\fR is appended to the file name, although this behaviour +can be turned on or off through the user preferences. +.SH "FILE FORMAT" +.IX Header "FILE FORMAT" +The \fBas-events\fR file contains \s-1ASCII\s0 text. The first line consists of an +identifier to associate the file type and version. Following text may contain +white space, comments, and data tuples. +.SH "GRAMMAR" +.IX Header "GRAMMAR" +\&\fBevents.as\fR ::= \fBeventsid\fR \fBtuplelist\fR +.PP +\&\fBeventsid\fR ::= \*(L"%!AS\-EVENTS\-\*(R" [0\-9] '.' [0\-9] +.PP +\&\fBtuplelist\fR ::= \fBtuplelist\fR | \fBtuple\fR | \fBcomment\fR | \s-1EMPTY\s0 +.PP +\&\fBtuple\fR ::= \fBuser\fR \fBuuid\fR \fBcrc\fR \fBrevision\fR \fBdate\fR \fBbegin\fR \fBend\fR \fBamount\fR \fBaccount\fR \fBremark\fR +.PP +\&\fBcomment\fR ::= ($#.*) +.PP +(* user field *) +.PP +\&\fBuser\fR ::= [a\-zA\-Z][a\-zA\-Z0\-9]+ +.PP +(* uuid field *) +.PP +\&\fBuuid\fR ::= \fBhexoctet\fR '\-' \fBhexquartet\fR '\-' \fBhexquartet\fR '\-' \fBhexquartet\fR '\-' \fBhextwelvetet\fR +.PP +(* crc field *) +.PP +\&\fBcrc\fR ::= \fBhexoctet\fR +.PP +\&\fBhextwelvetet\fR ::= \fBhexoctet\fR | \fBhexquartet\fR +.PP +\&\fBhexoctet\fR ::= \fBhexquartet\fR | \fBhexquartet\fR +.PP +\&\fBhexquartet\fR ::= \fBhexdigit\fR | \fBhexdigit\fR | \fBhexdigit\fR | \fBhexdigit\fR +.PP +\&\fBhexdigit\fR ::= \fBa\-zA\-Z0\-9\fR +.PP +(* revision field *) +.PP +\&\fBrevision\fR ::= [0\-9] +.PP +(* date field *) +.PP +\&\fBdate\fR ::= [0\-9][0\-9][0\-9][0\-9] '\-' [01][0\-9] '\-' [0123][0\-9] +.PP +(* time fields *) +.PP +\&\fBbegin\fR ::= \fBtimeval\fR +.PP +\&\fBend\fR ::= \fBendval\fR +.PP +\&\fBamount\fR ::= \fBtimeval\fR +.PP +\&\fBtimeval\fR ::= \fBhourval\fR ':' \fBminuteval\fR +.PP +\&\fBendval\fR ::= \fBhourinc\fR ':' \fBminuteval\fR +.PP +\&\fBhourval\fR ::= [01][0\-9] +.PP +\&\fBhourinc\fR ::= \fBhourval\fR | 2[0\-4] +.PP +\&\fBminval\fR ::= [0\-5][0\-9] +.PP +(* account field *) +.PP +\&\fBaccount\fR ::= \fBaccount\fR | \fBaccpart\fR +.PP +\&\fBaccpart\fR ::= \fBaccsep\fR \fBacctext\fR +.PP +\&\fBaccsep\fR ::= '/' +.PP +\&\fBacctext\fR ::= [a\-zA\-Z0\-9_\-]* +.PP +(* remark field *) +.PP +\&\fBremark\fR ::= '\*(L"' .* '\*(R"' +.SH "EXAMPLE" +.IX Header "EXAMPLE" +A typical \fBas-events\fR file might look like this: +.PP +%!AS\-EVENTS\-0.6 +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" +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" +harvey e230eae7\-367f\-4c35\-bee1\-202451b3c26f 02cb1abb 0 2002\-09\-30 00:00 00:00 00:30 /sales/travel/customer \*(L"Simontech visit\*(R" +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fIas\-gui\fR\|(1), +\&\fIas\-gui.conf\fR\|(5), +\&\fIas\-accounts\fR\|(5),