Bash Script Header

0
56

Auch wenn ein Script noch so einfach erscheint, gehört es dazu eine kurze Beschreibung abzuliefern wie das Script aufgerufen wird und welchen Zweck es hat.

Dies ist besonders dann wichtig, wenn mehrere Personen an einem System arbeiten. So kann gerade bei komplexeren Scripts schnell verstanden werden, was der jeweilige Zweck ist.

Syntax

#!/bin/bash
# Script Name:  <Name des Scripts>
# Beschreibung: <Was macht das Script?> # Aufruf: <Name des Scripts> [<1. Parameter>] [<2. Parameter>] # [<Beschreibung des 1. Parameters (falls vorhanden)>] # [<Beschreibung des 2. Parameters (falls vorhanden)>] # Autor: <Name des Script Autors> # Version: <Versionsnummer> # Datum: <Datum der letzen Änderung>

Beispiel

#!/bin/bash
# Script Name:  lerndoku-backup.sh
# Beschreibung: Ermöglicht das Sichern aller Dateien im Verzeichnis /lerndoku.com
# Aufruf:       lerndoku-backup.sh full
#               Sichert alle Dateien und Verzeichnisse des Verzeichnisses /lerndoku.com
# Aufruf:       lerndoku-backup.sh change
#               Sichert alle Dateien und Verzeichnisse des Verzeichnisses /lerndoku die seit der letzen Sicherung verändert wurden.
# Autor:        Mischa K. - Lerndoku.com
# Version:      1.0
# Datum:        12.01.2019 - 19:58

Erläuterungen

# Script Name:

Hier steht der Name des Scriptes unter welchem es abgespeichert wurde.

# Beschreibung

Was kann mit diesem Script gemacht werden? Welche Funktion hat es? Wird es ggf. automatisch durch crontab ausgeführt?

# Aufruf

Wie das Script ausgeführt werden kann steht hier beschrieben. Ebenfalls wird die Funktion allfällig benötigter Parameter beschrieben.

# Autor:

Wer hat das Script verfasst? Am besten wird der Autor mit vor und Nachnamen angegeben und ggf. mit dem Namen der entsprechenden Firma.

# Version:

Mit jeder Änderung die am Script vorgenommen wird, ändert sich auch die Version.

# Datum

Wann (Tag, Monat, Jahr sowie Uhrzeit) wurde das Script zuletzt geändert ?
Sobald das Script mehrfach vorhanden ist erhält man dadurch ebenfalls einen weiteren Anhaltspunkt ob es sich dabei um die aktuellste Datei handelt.

0 0 Bewertung
Article Rating
Abonnieren
Benachrichtige mich bei
guest
0 Comments
Inline Feedbacks
View all comments