Skip to content
Snippets Groups Projects
Commit 398bb176 authored by Heinz Deinhart's avatar Heinz Deinhart
Browse files

convert README to markdown

parent 37d14798
Branches
Tags
No related merge requests found
<!-- -*- mode: markdown; mode: flyspell -*- -->
## Introduction
AZAT is a small AWK tool that can be used to create Excel like Work
Reports. They contain month summaries, detailed time tables from
months and detailed work description tables. Holiday calculation is
included. The input format a very simple text format.
The azat binary (actually its a shell script) is call "azat". Use
"azat -h" to get a list of command line arguments. A sample call could be:
## Usage
Use `azat -h` to get a list of command line arguments:
```
azat: usage azat [OPTION [..]] <input-file> [..]
OPTION .. DESCRIPTION [DEFAULT VALUE]
-n <NAME> .. name of the hard working person
-m <EMAIL> .. email address of the same person
-l <LANG> .. language, currently: en|de
-d .. print debug messages
-D .. print more debug messages
-L <PATH> .. lib path [/usr/lib/azat]
-o <FILE> .. output file [-]
-t <TYPE> .. type of output file: txt|pdf|ps|tex (default: pdf)
-S .. suppress created by azat message
-h .. print usage message
-v .. print version information
```
# Example
A sample call could be:
```
azat -l de -n "John Doe" -m "worker@no-such-company.com" -o timetable-john-doe.ps 200507.azat 200508.azat 200509.azat 200510.azat 200511.azat 200512.azat 200601.azat 200602.azat 200603.azat 200604.azat 200605.azat
```
Note: This user stores each monch in a new file. This is not required but
Note: This user stores each month in a new file. This is not required but
recommended. You could even create timetables for only some months, but
currently this breaks the holiday calculation.
To get an impression what an azat source code looks like,
take a look at this small azat source:
--- begin demo.azat
```
0510 ADDHOLIDAY 10
051003 8:10 16:35
@moon eat some cheese
......@@ -27,7 +53,9 @@ take a look at this small azat source:
@clients format harddrives just for fun
051005 HOLIDAY
051005 CUSTOMSHOULD 4
--- end demo.azat
```
## Input File Format
There are three different line types. Month related commands, day specific
declarations and time range descriptions. All commands exist as english
......@@ -78,15 +106,22 @@ Replace CONTEXT with the context of the work (do not forget the @, no spaces
are allowed). Description text can be anything. Okay, probably anything that
is nice to the latex stage. The following conversions are done before calling
latex:
```
& -> \\&
_ -> \_
% -> \
" -> ''
Any missing conversions should be mailed to me. Short term solution:
Additional conversion can easily be hacked into azat.awk
(function output_month_donetable).
Please do not forget that this is not really an application, but a small hack.
Nevertheless, i would be interested to hear from you, if you find this useful.
At least it saves me from using an Excel timetable and this makes me
rather happy :)
```
Additional conversion can easily be hacked into `azat.awk` (function output_month_donetable).
## Logo
Source:
[Wikipedia](https://de.m.wikipedia.org/wiki/Datei:IBM_Stechuhr.jpg),
Author Yannick Trottier, 2006 Modified by Submeir, [Create
Commons](https://creativecommons.org/licenses/by-sa/4.0/deed.de).
<!-- LocalWords: AZAT AWK azat
-->
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment