.\" -*- 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 "MUNIN-RUN 1p" .TH MUNIN-RUN 1p 2024-05-20 "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 munin\-run \- A program to run Munin plugins from the command line .SH SYNOPSIS .IX Header "SYNOPSIS" munin-run [options] [ config | autoconf | snmpconf | suggest ] .SH DESCRIPTION .IX Header "DESCRIPTION" munin-run is a script to run Munin plugins from the command-line. It's useful when debugging plugins, as they are run in the same conditions as they are under munin-node. .SH OPTIONS .IX Header "OPTIONS" .IP "\fB\-\-config \fR" 5 .IX Item "--config " Use as configuration file. [/etc/munin/munin\-node.conf] .IP "\fB\-\-servicedir \fR" 5 .IX Item "--servicedir " Use as plugin dir. [/etc/munin/plugins/] .IP "\fB\-\-sconfdir \fR" 5 .IX Item "--sconfdir " Use as plugin configuration dir. [/etc/munin/plugin\-conf.d/] .IP "\fB\-\-sconffile \fR" 5 .IX Item "--sconffile " Use as plugin configuration. Overrides sconfdir. [undefined] .IP "\fB\-\-paranoia \fR" 5 .IX Item "--paranoia " Only run plugins owned by root and check permissions. [disabled] .IP "\fB\-\-ignore\-systemd\-properties \fR" 5 .IX Item "--ignore-systemd-properties " Do not try to detect and enforce the locally configured hardening flags of the "munin-node" service unit. This detection is skipped, if systemd is not enabled. The hardening flags may cause subtile surprises. For example "ProtectHome=yes" prevents the "df" plugin from determining the state of the "home" partition. [disabled] .IP "\fB\-\-help \fR" 5 .IX Item "--help " View this help message. .IP "\fB\-\-debug \fR" 5 .IX Item "--debug " Print debug messages. Debug messages are sent to STDOUT and are prefixed with "#" (this makes it easier for other parts of munin to use munin-run and still have \-\-debug on). Only errors go to STDERR. .IP "\fB\-\-pidebug \fR" 5 .IX Item "--pidebug " Plugin debug. Sets the environment variable MUNIN_DEBUG to 1 so that plugins may enable debugging. [disabled] .IP "\fB\-\-version \fR" 5 .IX Item "--version " Show version information. .SH "NOTES FOR SYSTEMD USERS" .IX Header "NOTES FOR SYSTEMD USERS" The "munin-node" service is usually started by systemd via a "munin\-node.service" definition. Some distributions enable hardening settings in this service file in order to restrict the allowed set of activities for the "munin-node" process. This may cause surprising differences between the result of "munin-run" and the real "munin-node" service. .PP A popular example of such a surprising restriction is "ProtectHome=yes" combined with the "df" plugin. The restriction silently prevents the plugin from determining the status of mountpoints below /home. .PP "munin-run" tries to mimic this behavior of "munin-node" automatically. Thus the execution of "munin-run df" should provide the same output as "echo fetch df | nc localhost munin". .PP If you want to debug potential issues of systemd restrictions, then you may want to use the parameters "\-\-ignore\-systemd\-properties" and "\-\-debug". Permanent overrides of systemd properties can be configured locally via "systemctl edit munin-node". See "man systemd.exec" for the documentation of systemd's properties. .SH FILES .IX Header "FILES" .Vb 5 \& /etc/munin/munin\-node.conf \& /etc/munin/plugins/* \& /etc/munin/plugin\-conf.d/* \& /run/munin/munin\-node.pid \& /var/log/munin/munin\-node.log .Ve .SH VERSION .IX Header "VERSION" This is munin-run (munin-node) v2.0.76 .SH AUTHORS .IX Header "AUTHORS" Audun Ytterdal, Jimmy Olsen, Tore Anderson, Nicolai Langfeldt, Lars Kruse. .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright (C) 2002\-2009 Audun Ytterdal, Jimmy Olsen, Tore Anderson, Nicolai Langfeldt / Linpro AS. Copyright (C) 2020 Lars Kruse .PP This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 dated June, 1991. .PP This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. .PP You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA.