]> git.ipfire.org Git - thirdparty/iptables.git/commitdiff
doc: xt_LED: nroff formatting requirements
authorJan Engelhardt <jengelh@medozas.de>
Fri, 4 Jun 2010 12:08:58 +0000 (14:08 +0200)
committerJan Engelhardt <jengelh@medozas.de>
Fri, 4 Jun 2010 12:09:19 +0000 (14:09 +0200)
Verbatim dashes need to be backslash-prefixed.

Signed-off-by: Jan Engelhardt <jengelh@medozas.de>
extensions/libxt_LED.man

index 0226f107d1c1afdfb45e3c6461a792b615a9fb76..81c2f2968a0a9a157593db3c7523c41b6fedace2 100644 (file)
@@ -4,11 +4,11 @@ system. One example might be to light up an LED for a few minutes every time
 an SSH connection is made to the local machine. The following options control
 the trigger behavior:
 .TP
-\fB--led-trigger-id\fP \fIname\fP
+\fB\-\-led\-trigger\-id\fP \fIname\fP
 This is the name given to the LED trigger. The actual name of the trigger
 will be prefixed with "netfilter-".
 .TP
-\fB--led-delay\fP \fIms\fP
+\fB\-\-led-delay\fP \fIms\fP
 This indicates how long (in milliseconds) the LED should be left illuminated
 when a packet arrives before being switched off again. The default is 0
 (blink as fast as possible.) The special value \fIinf\fP can be given to
@@ -16,7 +16,7 @@ leave the LED on permanently once activated. (In this case the trigger will
 need to be manually detached and reattached to the LED device to switch it
 off again.)
 .TP
-\fB--led-always-blink\fP
+\fB\-\-led\-always\-blink\fP
 Always make the LED blink on packet arrival, even if the LED is already on.
 This allows notification of new packets even with long delay values (which
 otherwise would result in a silent prolonging of the delay time.)
@@ -24,7 +24,7 @@ otherwise would result in a silent prolonging of the delay time.)
 Example:
 .TP
 Create an LED trigger for incoming SSH traffic:
-iptables -A INPUT -p tcp --dport 22 -j LED --led-trigger-id ssh
+iptables \-A INPUT \-p tcp \-\-dport 22 \-j LED \-\-led\-trigger\-id ssh
 .TP
 Then attach the new trigger to an LED:
-echo netfilter-ssh >/sys/class/leds/\fIledname\fP/trigger
+echo netfilter\-ssh >/sys/class/leds/\fIledname\fP/trigger