as-events.5

Fri, 28 Nov 2008 11:21:08 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Fri, 28 Nov 2008 11:21:08 +0100
changeset 1
d64aaa7d146f
permissions
-rw-r--r--

Fork project trunk at version 0.7.7 to maintain for future usage.
The original Cable & Wireless development team no longer exists.
The OSSP CVS repository is unavailable (cvs co ossp-pkg/as fails),
however http://cvs.ossp.org/dirview?d=ossp-pkg/as/as-gui is working.

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

mercurial