.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "MUNINDOC 1p" .TH MUNINDOC 1p 2024-02-28 "perl v5.38.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME munindoc \- Munin documentation .SH DESCRIPTION .IX Header "DESCRIPTION" This program displays Munin documentation, esp. plugin documentation. Note that not all plugins are documented yet. .PP Most Munin commands (such as munin-run, and munindoc itself) is only documented through the usual Unix man command. .SH "PLUGIN DOCUMENTATION" .IX Header "PLUGIN DOCUMENTATION" The plugin documentation should include basic usage information, anything you want to know about configuration, and how to interpret the output. .PP Additional information typically found is usually the name of the plugin author, licensing and "magic markers" which controls plugin auto configuration (done by munin-node-configure). .PP If you want to document a plugin you can take a look at http://munin\-monitoring.org/wiki/munindoc for details on how to do it. .SH AUTHOR .IX Header "AUTHOR" (C) 2008\-2009 Nicolai Langfeldt, Redpill Linpro AS. ...But all the work is handed off to the perldoc command once we have located the Munin documentation files. .SH LICENSE .IX Header "LICENSE" GPLv2