Skip to content
This repository has been archived by the owner on Mar 19, 2021. It is now read-only.

Commit

Permalink
autodoc: added skeleton for bareos-sd
Browse files Browse the repository at this point in the history
adapted to json schema export format-version=2
  • Loading branch information
joergsteffens committed Dec 29, 2014
1 parent acc7aa6 commit f5bcdaa
Show file tree
Hide file tree
Showing 12 changed files with 607 additions and 67 deletions.
24 changes: 18 additions & 6 deletions manuals/en/main/Makefile
Expand Up @@ -9,6 +9,7 @@ PDFLATEX=pdflatex
MAKEINDEX=makeindex
CONVERT=convert
BAREOS_DIR=/usr/sbin/bareos-dir
BAREOS_SD=/usr/sbin/bareos-sd
GENERATED_RESOURCE_DESCRIPTIONS=../../scripts/generate-resoure-descriptions.py

INDEXES = bareos-manual-main-reference.console.ind \
Expand Down Expand Up @@ -37,7 +38,7 @@ pdf: bareos-manual-main-reference.pdf

html: html/bareos-manual-main-reference.html

html/bareos-manual-main-reference.html: depend *.sty *.tex autogenerated/*.tex $(HTINDEXES) bareos-manual-main-reference.toc
html/bareos-manual-main-reference.html: depend *.sty *.tex bareos-manual-main-reference.htlatex.cfg autogenerated/bareos-dir-*.tex autogenerated/bareos-sd-*.tex $(HTINDEXES) bareos-manual-main-reference.toc
mkdir -p html
htlatex bareos-manual-main-reference "bareos-manual-main-reference.htlatex.cfg" "" -d./html/

Expand All @@ -59,27 +60,38 @@ html/bareos-manual-main-reference.html: depend *.sty *.tex autogenerated/*.tex $
bareos-manual-main-reference.toc: *.tex
$(LATEX) bareos-manual-main-reference.tex

bareos-manual-main-reference.dvi: depend *.sty *.tex autogenerated/*.tex $(INDEXES) bareos-manual-main-reference.toc
bareos-manual-main-reference.dvi: depend *.sty *.tex autogenerated/bareos-dir-*.tex autogenerated/bareos-sd-*.tex $(INDEXES) bareos-manual-main-reference.toc
$(LATEX) bareos-manual-main-reference.tex
$(LATEX) bareos-manual-main-reference.tex

bareos-manual-main-reference.pdf: depend *.sty *.tex autogenerated/*.tex $(INDEXES) bareos-manual-main-reference.toc
bareos-manual-main-reference.pdf: depend *.sty *.tex autogenerated/bareos-dir-*.tex autogenerated/bareos-sd-*.tex $(INDEXES) bareos-manual-main-reference.toc
$(PDFLATEX) bareos-manual-main-reference.tex
$(PDFLATEX) bareos-manual-main-reference.tex

autogenerated/bareos-dir-config-schema.json:
$(MKDIR) autogenerated/
# generate config-schema file.
# bareos-dir requires a valid configuration file for that.
# Test if creation succeeded, if yes, redirct output to a json file.
if $(BAREOS_DIR) -x; then \
$(BAREOS_DIR) -x > autogenerated/bareos-dir-config-schema.json; \
fi

autogenerated/*.tex: autogenerated/bareos-dir-config-schema.json
# generates all director-resource files, not only director-resource-director-table.tex
autogenerated/bareos-sd-config-schema.json:
$(MKDIR) autogenerated/
# generate config-schema file.
# Test if creation succeeded, if yes, redirct output to a json file.
if $(BAREOS_SD) -x; then \
$(BAREOS_SD) -x > autogenerated/bareos-sd-config-schema.json; \
fi

autogenerated/bareos-dir-*.tex: autogenerated/bareos-dir-config-schema.json
# generates all director-resource files
$(GENERATED_RESOURCE_DESCRIPTIONS) autogenerated/bareos-dir-config-schema.json

autogenerated/bareos-sd-*.tex: autogenerated/bareos-sd-config-schema.json
# generates all storage daemin resource files
$(GENERATED_RESOURCE_DESCRIPTIONS) autogenerated/bareos-sd-config-schema.json

check: bareos-manual-main-reference.pdf
@# hyperlink: multiline: pdfTeX warning .* has been reference$d but does not exist
@# defDirective multiline: Warning: defDirective{Dir}{Director}{PluginNames} has no matching resourceDirec$tive and will be ignored.
Expand Down
15 changes: 15 additions & 0 deletions manuals/en/main/bareos-sd-resource-autochanger-definitions.tex
@@ -0,0 +1,15 @@
\defDirective{Sd}{Autochanger}{Changer Command}{}{}{%
}

\defDirective{Sd}{Autochanger}{Changer Device}{}{}{%
}

\defDirective{Sd}{Autochanger}{Description}{}{}{%
}

\defDirective{Sd}{Autochanger}{Device}{}{}{%
}

\defDirective{Sd}{Autochanger}{Name}{}{}{%
}

195 changes: 195 additions & 0 deletions manuals/en/main/bareos-sd-resource-device-definitions.tex
@@ -0,0 +1,195 @@
\defDirective{Sd}{Device}{Alert Command}{}{}{%
}

\defDirective{Sd}{Device}{Always Open}{}{}{%
}

\defDirective{Sd}{Device}{Archive Device}{}{}{%
}

\defDirective{Sd}{Device}{Auto Deflate}{}{}{%
}

\defDirective{Sd}{Device}{Auto Deflate Algorithm}{}{}{%
}

\defDirective{Sd}{Device}{Auto Deflate Level}{}{}{%
}

\defDirective{Sd}{Device}{Auto Inflate}{}{}{%
}

\defDirective{Sd}{Device}{Auto Select}{}{}{%
}

\defDirective{Sd}{Device}{Autochanger}{}{}{%
}

\defDirective{Sd}{Device}{Automatic Mount}{}{}{%
}

\defDirective{Sd}{Device}{Backward Space File}{}{}{%
}

\defDirective{Sd}{Device}{Backward Space Record}{}{}{%
}

\defDirective{Sd}{Device}{Block Checksum}{}{}{%
}

\defDirective{Sd}{Device}{Block Positioning}{}{}{%
}

\defDirective{Sd}{Device}{Bs Fat Eom}{}{}{%
}

\defDirective{Sd}{Device}{Changer Command}{}{}{%
}

\defDirective{Sd}{Device}{Changer Device}{}{}{%
}

\defDirective{Sd}{Device}{Check Labels}{}{}{%
}

\defDirective{Sd}{Device}{Close On Poll}{}{}{%
}

\defDirective{Sd}{Device}{Collect Statistics}{}{}{%
}

\defDirective{Sd}{Device}{Description}{}{}{%
}

\defDirective{Sd}{Device}{Device Type}{}{}{%
}

\defDirective{Sd}{Device}{Diagnostic Device}{}{}{%
}

\defDirective{Sd}{Device}{Drive Crypto Enabled}{}{}{%
}

\defDirective{Sd}{Device}{Drive Index}{}{}{%
}

\defDirective{Sd}{Device}{Drive Tape Alert Enabled}{}{}{%
}

\defDirective{Sd}{Device}{Fast Forward Space File}{}{}{%
}

\defDirective{Sd}{Device}{Forward Space File}{}{}{%
}

\defDirective{Sd}{Device}{Forward Space Record}{}{}{%
}

\defDirective{Sd}{Device}{Free Space Command}{}{}{%
}

\defDirective{Sd}{Device}{Hardware End Of File}{}{}{%
}

\defDirective{Sd}{Device}{Hardware End Of Medium}{}{}{%
}

\defDirective{Sd}{Device}{Label Block Size}{}{}{%
}

\defDirective{Sd}{Device}{Label Media}{}{}{%
}

\defDirective{Sd}{Device}{Label Type}{}{}{%
}

\defDirective{Sd}{Device}{Maximum Block Size}{}{}{%
}

\defDirective{Sd}{Device}{Maximum Changer Wait}{}{}{%
}

\defDirective{Sd}{Device}{Maximum Concurrent Jobs}{}{}{%
}

\defDirective{Sd}{Device}{Maximum File Size}{}{}{%
}

\defDirective{Sd}{Device}{Maximum Job Spool Size}{}{}{%
}

\defDirective{Sd}{Device}{Maximum Network Buffer Size}{}{}{%
}

\defDirective{Sd}{Device}{Maximum Open Volumes}{}{}{%
}

\defDirective{Sd}{Device}{Maximum Open Wait}{}{}{%
}

\defDirective{Sd}{Device}{Maximum Part Size}{}{}{%
}

\defDirective{Sd}{Device}{Maximum Rewind Wait}{}{}{%
}

\defDirective{Sd}{Device}{Maximum Spool Size}{}{}{%
}

\defDirective{Sd}{Device}{Maximum Volume Size}{}{}{%
}

\defDirective{Sd}{Device}{Media Type}{}{}{%
}

\defDirective{Sd}{Device}{Minimum Block Size}{}{}{%
}

\defDirective{Sd}{Device}{Mount Command}{}{}{%
}

\defDirective{Sd}{Device}{Mount Point}{}{}{%
}

\defDirective{Sd}{Device}{Name}{}{}{%
}

\defDirective{Sd}{Device}{No Rewind On Close}{}{}{%
}

\defDirective{Sd}{Device}{Offline On Unmount}{}{}{%
}

\defDirective{Sd}{Device}{Query Crypto Status}{}{}{%
}

\defDirective{Sd}{Device}{Random Access}{}{}{%
}

\defDirective{Sd}{Device}{Removable Media}{}{}{%
}

\defDirective{Sd}{Device}{Requires Mount}{}{}{%
}

\defDirective{Sd}{Device}{Spool Directory}{}{}{%
}

\defDirective{Sd}{Device}{Two Eof}{}{}{%
}

\defDirective{Sd}{Device}{Unmount Command}{}{}{%
}

\defDirective{Sd}{Device}{Use Mtiocget}{}{}{%
}

\defDirective{Sd}{Device}{Volume Capacity}{}{}{%
}

\defDirective{Sd}{Device}{Volume Poll Interval}{}{}{%
}

\defDirective{Sd}{Device}{Write Part Command}{}{}{%
}

51 changes: 51 additions & 0 deletions manuals/en/main/bareos-sd-resource-director-definitions.tex
@@ -0,0 +1,51 @@
\defDirective{Sd}{Director}{Description}{}{}{%
}

\defDirective{Sd}{Director}{Key Encryption Key}{}{}{%
}

\defDirective{Sd}{Director}{Maximum Bandwidth Per Job}{}{}{%
}

\defDirective{Sd}{Director}{Monitor}{}{}{%
}

\defDirective{Sd}{Director}{Name}{}{}{%
}

\defDirective{Sd}{Director}{Password}{}{}{%
}

\defDirective{Sd}{Director}{TLS Allowed CN}{}{}{%
}

\defDirective{Sd}{Director}{TLS Authenticate}{}{}{%
}

\defDirective{Sd}{Director}{TLS CA Certificate Dir}{}{}{%
}

\defDirective{Sd}{Director}{TLS CA Certificate File}{}{}{%
}

\defDirective{Sd}{Director}{TLS Certificate}{}{}{%
}

\defDirective{Sd}{Director}{TLS Certificate Revocation List}{}{}{%
}

\defDirective{Sd}{Director}{TLS DH File}{}{}{%
}

\defDirective{Sd}{Director}{TLS Enable}{}{}{%
}

\defDirective{Sd}{Director}{TLS Key}{}{}{%
}

\defDirective{Sd}{Director}{TLS Require}{}{}{%
}

\defDirective{Sd}{Director}{TLS Verify Peer}{}{}{%
}

48 changes: 48 additions & 0 deletions manuals/en/main/bareos-sd-resource-messages-definitions.tex
@@ -0,0 +1,48 @@
\defDirective{Sd}{Messages}{Append}{}{}{%
}

\defDirective{Sd}{Messages}{Catalog}{}{}{%
}

\defDirective{Sd}{Messages}{Console}{}{}{%
}

\defDirective{Sd}{Messages}{Description}{}{}{%
}

\defDirective{Sd}{Messages}{Director}{}{}{%
}

\defDirective{Sd}{Messages}{File}{}{}{%
}

\defDirective{Sd}{Messages}{Mail}{}{}{%
}

\defDirective{Sd}{Messages}{Mail Command}{}{}{%
}

\defDirective{Sd}{Messages}{Mail On Error}{}{}{%
}

\defDirective{Sd}{Messages}{Mail On Success}{}{}{%
}

\defDirective{Sd}{Messages}{Name}{}{}{%
}

\defDirective{Sd}{Messages}{Operator}{}{}{%
}

\defDirective{Sd}{Messages}{Operator Command}{}{}{%
}

\defDirective{Sd}{Messages}{Stderr}{}{}{%
}

\defDirective{Sd}{Messages}{Stdout}{}{}{%
}

\defDirective{Sd}{Messages}{Syslog}{}{}{%
}

18 changes: 18 additions & 0 deletions manuals/en/main/bareos-sd-resource-ndmp-definitions.tex
@@ -0,0 +1,18 @@
\defDirective{Sd}{Ndmp}{Auth Type}{}{}{%
}

\defDirective{Sd}{Ndmp}{Description}{}{}{%
}

\defDirective{Sd}{Ndmp}{Log Level}{}{}{%
}

\defDirective{Sd}{Ndmp}{Name}{}{}{%
}

\defDirective{Sd}{Ndmp}{Password}{}{}{%
}

\defDirective{Sd}{Ndmp}{Username}{}{}{%
}

0 comments on commit f5bcdaa

Please sign in to comment.