README.md 2.05 KB
Newer Older
frnmst's avatar
frnmst committed
1
# monthly-attendance-paper
frnmst's avatar
frnmst committed
2
3
4
5

A simple bash script that generates a monthly printout calendar template to be 
used between an employer and employee.

frnmst's avatar
frnmst committed
6
7
8
9
10
11
12
**Warning: THIS REPOSITORY IS DEPRECATED. HAVE A LOOK HERE:**

- https://software.franco.net.eu.org/frnmst/automated-tasks
- https://codeberg.org/frnmst/automated-tasks
- https://github.com/frnmst/automated-tasks
- https://docs.franco.net.eu.org/automated-tasks/scripts.html#monthly-attendance-paper-py

13
## Table of contents
frnmst's avatar
frnmst committed
14

15
<!--TOC-->
frnmst's avatar
frnmst committed
16

17
18
19
20
21
22
23
24
25
- [monthly-attendance-paper](#monthly-attendance-paper)
  - [Table of contents](#table-of-contents)
  - [Dependencies](#dependencies)
  - [Example](#example)
  - [Configuration](#configuration)
  - [Running](#running)
  - [Printing](#printing)
  - [Warning](#warning)
  - [License](#license)
frnmst's avatar
frnmst committed
26

27
<!--TOC-->
frnmst's avatar
frnmst committed
28

29
## Dependencies
frnmst's avatar
frnmst committed
30

31
32
33
34
35
36
37
| Package name | Version | Required |
|--------------|---------|----------|
| [GNU Bash](http://www.gnu.org/software/bash/bash.html) | 5.0.011(1) | yes |
| [Coreutils](https://www.gnu.org/software/coreutils/) | 8.31 | yes |
| [Gawk](http://www.gnu.org/software/gawk/) | 5.0.1 | yes |
| [util-linux](https://www.kernel.org/pub/linux/utils/util-linux/) | 2.34 | yes |
| [CUPS](http://www.cups.org/) | 2.3.0 | no |
38
39
40
41
42

## Example

See [example.txt](example.txt) for an example printout. Note 
that the example was made to test a leap year.
frnmst's avatar
frnmst committed
43
44
45

## Configuration

46
47
Edit the `./configrc` file based on your needs. 
Variable names are self-explanatory.
frnmst's avatar
frnmst committed
48

49
You can also edit the date formats in the following script functions:
frnmst's avatar
frnmst committed
50
51
52
53
54
55

    get_full_string()
    print_day()

## Running

56
    $ ./monthly_attendace_paper.sh ./configrc
frnmst's avatar
frnmst committed
57
58
59

## Printing

60
    $ ./monthly_attendace_paper.sh ./configrc | lpr
frnmst's avatar
frnmst committed
61
62
63

## Warning

64
65
66
67
This script heavily depends on tabs for formatting. What you see
in a printout may be different to what you see on the screen;
what you see on an editor after executing:

68
    $ ./monthly_attendace_paper.sh ./configrc > printout.txt
69
70
71

might be different than:

72
    $ ./monthly_attendace_paper.sh ./configrc
73

frnmst's avatar
frnmst committed
74
75
76
77
78
79
80
This script does not check any input nor output for errors. 
That's up to you.

## License

CC0.