summaryrefslogtreecommitdiffstats
path: root/web/content/doc
diff options
context:
space:
mode:
Diffstat (limited to 'web/content/doc')
-rw-r--r--web/content/doc/faq/index.md9
-rw-r--r--web/content/doc/index.md26
-rw-r--r--web/content/doc/man/index.md20
l---------web/content/doc/news.txt1
-rw-r--r--web/content/doc/presentation.md26
5 files changed, 82 insertions, 0 deletions
diff --git a/web/content/doc/faq/index.md b/web/content/doc/faq/index.md
new file mode 100644
index 0000000..18584f2
--- /dev/null
+++ b/web/content/doc/faq/index.md
@@ -0,0 +1,9 @@
1title: FAQ
2parent: Documentation
3---
4
5# FAQ
6
7The list of Frequently Asked Questions (FAQ) will come back soon.
8
9<!--% # vim:set filetype=markdown textwidth=78 joinspaces: # %-->
diff --git a/web/content/doc/index.md b/web/content/doc/index.md
new file mode 100644
index 0000000..7b2d098
--- /dev/null
+++ b/web/content/doc/index.md
@@ -0,0 +1,26 @@
1title: Documentation
2parent: Home
3menu-position: 3
4---
5
6# Documentation
7
8The Nagios Plugins documentation is split up into three parts:
9
101. **[Manual Pages][man]**
11 This part provides documentation for each individual plugin.
12
132. **[FAQ][faq]**
14 The FAQ section offers additional information on the Nagios Plugins
15 package as a whole.
16
173. **[Presentation][video]**
18 A video that shows how to write your own check using the
19 [Nagios::Plugin][module] Perl module.
20
21[man]: doc/man/index.html "Manual Pages"
22[faq]: doc/faq/index.html "Frequently Asked Questions"
23[video]: doc/presentation.html "Nagios::Plugin Presentation"
24[module]: http://search.cpan.org/dist/Nagios-Plugin/ "Nagios::Plugin"
25
26<!--% # vim:set filetype=markdown textwidth=78 joinspaces: # %-->
diff --git a/web/content/doc/man/index.md b/web/content/doc/man/index.md
new file mode 100644
index 0000000..d3c60c8
--- /dev/null
+++ b/web/content/doc/man/index.md
@@ -0,0 +1,20 @@
1title: Manpages
2parent: Documentation
3---
4
5# Manual Pages
6
7There are two levels of documentation for each plugin:
8
91. **`check_dummy --usage`**
10 Basic usage, with the most common command line options.
11
122. **`check_dummy --help`**
13 More text, listing all the options available for a plugin. This text is
14 usually translated.
15
16You can also access the most recent `--help` output for each plugin online:
17
18<!--% list_kids() %-->
19
20<!--% # vim:set filetype=markdown textwidth=78 joinspaces: # %-->
diff --git a/web/content/doc/news.txt b/web/content/doc/news.txt
new file mode 120000
index 0000000..f5208d5
--- /dev/null
+++ b/web/content/doc/news.txt
@@ -0,0 +1 @@
/home/plugins/exported/nagios-plugins/NEWS \ No newline at end of file
diff --git a/web/content/doc/presentation.md b/web/content/doc/presentation.md
new file mode 100644
index 0000000..458b101
--- /dev/null
+++ b/web/content/doc/presentation.md
@@ -0,0 +1,26 @@
1title: Presentation
2parent: Documentation
3---
4
5# Presentation
6
7Former Nagios Plugins team lead Ton Voon gave a 15-minutes lightning talk
8about the Nagios Plugins at [FOSDEM][fosdem]. He made a screencast of [the
9presentation][talk] in Quicktime format (35&nbsp;MB):
10
11* [fosdem.mov][screencast]
12
13The `check_weather` script demonstrated in the screencast is also available
14for download, with additional comments:
15
16* [check_weather.pl][script]
17
18Both files are also [available via FTP][mirror].
19
20[fosdem]: https://fosdem.org/ "FOSDEM"
21[talk]: https://archive.fosdem.org/2007/schedule/events/lt_nagios_plugins.html "Ton's Talk"
22[screencast]: https://www.nagios-plugins.org/download/presentation/fosdem.mov "Screencast"
23[script]: https://www.nagios-plugins.org/download/presentation/check_weather.pl "check_weather"
24[mirror]: ftp://ftp.fu-berlin.de/unix/network/nagios-plugins/presentation/ "FTP Mirror"
25
26<!--% # vim:set filetype=markdown textwidth=78 joinspaces: # %-->