Experimental, mdoc -> markdown generation of man pages

Signed-off-by: Joachim Wiberg <[email protected]>

Makefile

@@ -85,5 +85,10 @@ dist:
 	@(cd ..; md5sum $(ARCHIVE) | tee $(ARCHIVE).md5)
 	@(cd ..; sha256sum $(ARCHIVE) | tee $(ARCHIVE).sha256)
 
+doc:
+	@for file in $(EXEC); do \
+		mandoc -mdoc -T markdown $$file.8 > $$file\(8\).md; \
+	done
+
 # Include automatically generated rules
 -include $(DEPS)

README.md

@@ -3,8 +3,8 @@
 This is a cleaned up version of mtools from the [University of Virginia's
 Multimedia Networks Group][1], with added IPv6 and optional SSM support.
 
-The tools `msend` and `mreceive` can be particulary useful when debugging
-multicast setups.
+The tools [`msend(8)`](msend(8).md) and [`mreceive(8)`](mreceive(8).md)
+can be particulary useful when debugging multicast setups.
 
 > Remember, when routing multicast, always check the TTL!
 

mreceive(8).md

@@ -0,0 +1,132 @@
+MSEND(8) - System Manager's Manual (smm)
+
+# NAME
+
+**mreceive** - receive UDP multicast messages and display them
+
+# SYNOPSIS
+
+**mreceive**
+\[**-46hnvq**]
+\[**-g** *GROUP*]
+\[**-i** *ADDRESS*]
+\[...]
+\[**-i** *ADDRESS*]
+\[**-I** *INTERFACE*]
+\[**-p** *PORT*]
+\[**-s** *ADDRESS*]
+
+# DESCRIPTION
+
+Join a multicast group specified by the
+**-g**
+and
+**-p**
+options, then receive and display the multicast packets sent to this
+group:port by the
+msend(8)
+command.
+
+# OPTIONS
+
+**-4**
+
+> Select IPv4 test group, use with
+> **-I** *IFACE*
+> when not using
+> **-i** *ADDRESS*
+> or any
+> **-g** *GROUP*.
+> This is the default.
+
+**-6**
+
+> Select IPv6 test group when not using
+> or
+> **-g**.
+> For an example, see below.
+
+**-s** *ADDRESS*
+
+> Optional source IP address for source-specific filtering (SSM).  By
+> default,
+> **mreceive**
+> runs in any-source multicast (ASM) mode.
+
+**-g** *GROUP*
+
+> Specify the IP multicast address from which the packets are received.
+> The default group is
+> **224.1.1.1**.
+
+**-p** *PORT*
+
+> Specify the UDP port number used by the multicast group.  The default
+> port number is
+> **4444**.
+
+**-q**
+
+> Quiet mode, do not log to stdout every time a message is received.
+> Errors are stil logged.
+
+**-i** *ADDRESS*
+
+> Specify the IP addresses of one or more interfaces to receive multicast
+> packets.  The default value is
+> **INADDR\_ANY**
+> which implies that the default interface selected by the system will be
+> used.
+
+**-I** *INTERFACE*
+
+> The interface on which to receive.  Can be specified as an alternative
+> to
+> **-i**.
+
+**-n**
+
+> Interpret the contents of the message as a number instead of a string of
+> characters.  This option should be given when running
+> **msend**
+> with the
+> **-n**
+> option.
+
+**-v**
+
+> Print version information.
+
+**-h**
+
+> Print the command usage.
+
+# EXAMPLE
+
+	$ mreceive -6 -I eth0
+	Now receiving from multicast group: [ff2e::1]:4444
+	Receive msg 1 from [2001:9b0:214:3500::c2e]:37801:
+	Receive msg 2 from [2001:9b0:214:3500::c2e]:37801:
+	Receive msg 3 from [2001:9b0:214:3500::c2e]:37801:
+	Receive msg 4 from [2001:9b0:214:3500::c2e]:37801:
+	^C
+
+# SEE ALSO
+
+msend(8)
+
+# AUTHORS
+
+**mtools**,
+originally called mSendReceive, was written by
+Jianping Wang,
+Yvan Pointurier,
+and
+Jörg Liebeherr
+while at University of Virginia's Multimedia Networks Group.  It is
+currently maintained by
+Joachim Wiberg
+at
+[GitHub](https://github.com/troglobit/mtools).
+
+Debian - November 11, 2024

msend(8).md

@@ -0,0 +1,149 @@
+MSEND(8) - System Manager's Manual (smm)
+
+# NAME
+
+**msend** - send UDP messages to a multicast group
+
+# SYNOPSIS
+
+**msend**
+\[**-46hnvq**]
+\[**-c** *NUM*]
+\[**-g** *GROUP*]
+\[**-join**]
+\[**-i** *ADDRESS*]
+\[**-I** *INTERFACE*]
+\[**-p** *PORT*]
+\[**-P** *PERIOD*]
+\[**-t** *TTL*]
+\[**-text** *'text'*]
+
+# DESCRIPTION
+
+Continuously send UDP packets to the multicast group specified by the
+**-g**
+and
+**-p**
+options.
+
+# OPTIONS
+
+**-4**
+
+> Select IPv4 test group, use with
+> **-I** *IFACE*
+> when not using
+> **-i** *ADDRESS*
+> or any
+> **-g** *GROUP*.
+> This is the default.
+
+**-6**
+
+> Select IPv6 test group when not using
+> or
+> **-g**.
+> For an example, see below.
+
+**-c** *NUM*
+
+> Limit number of packets to send, default: unlimited.
+
+**-g** *GROUP*
+
+> Specify the IP multicast group address to which the packets are sent.
+> The default group for IPv4 is
+> **224.1.1.1**
+> and for IPv6
+> **ff2e::1**.
+
+**-p** *PORT*
+
+> Specify the UDP port number used by the multicast group.  The default
+> port number is
+> **4444**.
+
+**-join**
+
+> Multicast sender will join join the multicast group.  By default, a
+> multicast sender does not (need to) join the group.
+
+**-t** *TTL*
+
+> Specify the TTL (1-255) value in the message.  You must increase this if
+> you want to route the traffic, otherwise the first router will drop the
+> packets!  The default value is 1.
+
+**-i** *ADDRESS*
+
+> Specify the IP address of the interface to be used to send the packets.
+> The default value is INADDR\_ANY which implies that the default interface
+> selected by the system will be used.
+
+**-I** *INTERFACE*
+
+> The interface on which to send.  Can be specified as an alternative to
+> **-i**.
+
+**-P** *PERIOD*
+
+> Specify the interval in milliseconds between two transmitted packets.
+> The default value is 1000 milliseconds.
+
+**-q**
+
+> Quiet mode, do not log to stdout every time a message is successfully
+> sent.  Errors are stil logged.
+
+**-text** *'text'*
+
+> Specify a message text which is sent as the payload of the packets and
+> is displayed by the
+> mreceive(8)
+> command.  The default value is an empty string.
+
+**-n**
+
+> Interpret the contents of the message text as a number instead of a
+> string of characters.  Use
+> **mreceive**
+> **-n**
+> on the other end to interpret the message text correctly.
+
+**-v**
+
+> Print version information.
+
+**-h**
+
+> Print the command usage.
+
+# EXAMPLE
+
+	$ msend -6 -I eth0
+	Now sending to multicast group: [ff2e::1]:4444
+	Sending msg 1, TTL 1, to [ff2e::1]:4444:
+	Sending msg 2, TTL 1, to [ff2e::1]:4444:
+	Sending msg 3, TTL 1, to [ff2e::1]:4444:
+	Sending msg 4, TTL 1, to [ff2e::1]:4444:
+	Sending msg 5, TTL 1, to [ff2e::1]:4444:
+
+# SEE ALSO
+
+mreceive(8)
+
+# AUTHORS
+
+**mtools**,
+originally called mSendReceive, was written by
+Jianping Wang,
+Yvan Pointurier,
+and
+Jörg Liebeherr
+while at University of Virginia's Multimedia Networks Group.  It is
+currently maintained by
+Joachim Wiberg
+at
+[GitHub](https://github.com/troglobit/mtools).
+
+Debian - November 11, 2024