summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/macping.141
-rw-r--r--docs/mactelnet.142
-rw-r--r--docs/mactelnetd.132
-rw-r--r--docs/mndp.122
4 files changed, 137 insertions, 0 deletions
diff --git a/docs/macping.1 b/docs/macping.1
new file mode 100644
index 0000000..aea01e5
--- /dev/null
+++ b/docs/macping.1
@@ -0,0 +1,41 @@
+.TH MACPING 1 "February 27, 2011"
+.SH NAME
+macping \- A tool for pinging other RouterOS or mactelnetd devices
+.SH SYNOPSIS
+.B mactelnet
+.RI [ options ] " " < MAC-Address | hostname >
+.SH DESCRIPTION
+This tool enables you to ping other RouterOS or MAC-Telnetd enabled
+devices. You can ping either a hostname or a MAC address.
+If specified, the hostname (identity) will be looked up via MNDP discovery.
+.SH OPTIONS
+These programs follow the usual GNU command line syntax.
+A summary of options is included below.
+.TP
+.B \-f
+Fast mode, do not wait before sending next ping request. The next ping will be sent immediately when the last ping is received. This cannot be used with
+.B -c 0
+\.
+.TP
+.B \-s
+Specify the amount of bytes to send in each ping packet, up to ~1400 bytes.
+.TP
+.B \-c
+Number of packets to send before exiting. A value of
+.B 0
+means unlimited packets and the tool must be exited with Control + C.
+.TP
+.B \-h
+Show summary of options.
+.TP
+.B \-v
+Show version of program.
+.SH SEE ALSO
+.BR mndp (1),
+.BR mactelnet (1),
+.BR mactelnetd (1).
+.SH AUTHOR
+macping was written by Håkon Nessjøen <haakon.nessjoen@gmail.com>.
+.PP
+This manual page was written by Håkon Nessjøen <haakon.nessjoen@gmail.com>,
+for the Debian project (and may be used by others).
diff --git a/docs/mactelnet.1 b/docs/mactelnet.1
new file mode 100644
index 0000000..7ca091e
--- /dev/null
+++ b/docs/mactelnet.1
@@ -0,0 +1,42 @@
+.TH MACTELNET 1 "February 27, 2011"
+.SH NAME
+mactelnet \- A tool for telneting via MAC addresses
+.SH SYNOPSIS
+.B mactelnet
+.RI [ options ] " " < MAC-Address | hostname >
+.SH DESCRIPTION
+This tool enables you to telnet other RouterOS or MAC-Telnetd enabled
+devices. You can connect to either a hostname or a MAC address.
+If specified, the hostname (identity) will be looked up via MNDP discovery.
+.SH OPTIONS
+These programs follow the usual GNU command line syntax.
+A summary of options is included below.
+.TP
+.B \-n
+Do not use broadcast packets. A tad less insecure but requires root privileges.
+This means that ethernet packets will have the specified mac-address as the packet
+destination, instead of using the ethernet broadcast address.
+.TP
+.B \-t
+Amount of seconds to wait for a response on each interface. If you have several network interfaces, this is the timeout value per interface.
+.TP
+.B \-u
+Specify username. Without this option, you will need to enter the username in a interactive prompt.
+.TP
+.B \-p
+Specify password. Without this option, you will need to enter the password in a interactive prompt.
+.TP
+.B \-h
+Show summary of options.
+.TP
+.B \-v
+Show version of program.
+.SH SEE ALSO
+.BR mndp (1),
+.BR mactelnetd (1),
+.BR macping (1).
+.SH AUTHOR
+mactelnet was written by Håkon Nessjøen <haakon.nessjoen@gmail.com>.
+.PP
+This manual page was written by Håkon Nessjøen <haakon.nessjoen@gmail.com>,
+for the Debian project (and may be used by others).
diff --git a/docs/mactelnetd.1 b/docs/mactelnetd.1
new file mode 100644
index 0000000..b4fd298
--- /dev/null
+++ b/docs/mactelnetd.1
@@ -0,0 +1,32 @@
+.TH MACTELNETD 1 "February 27, 2011"
+.SH NAME
+mactelnetd \- Telnet daemon for MAC-address connections
+.SH SYNOPSIS
+.B mactelnetd
+.RI [ options ]
+.SH DESCRIPTION
+This daemon listens for telnet connections from Mikrotik RouterOS devices or mactelnet clients
+on the same physical network. It also announces it's hostname via the MNDP protocol every minute.
+.SH OPTIONS
+These programs follow the usual GNU command line syntax.
+A summary of options is included below.
+.TP
+.B \-n
+Do not use broadcast packets. A tad less insecure.
+This means that ethernet packets will have the mac-address of the client as the packet
+destination, instead of using the ethernet broadcast address.
+.TP
+.B \-h
+Show summary of options.
+.TP
+.B \-v
+Show version of program.
+.SH SEE ALSO
+.BR mndp (1),
+.BR mactelnet (1),
+.BR macping (1).
+.SH AUTHOR
+mactelnetd was written by Håkon Nessjøen <haakon.nessjoen@gmail.com>.
+.PP
+This manual page was written by Håkon Nessjøen <haakon.nessjoen@gmail.com>,
+for the Debian project (and may be used by others).
diff --git a/docs/mndp.1 b/docs/mndp.1
new file mode 100644
index 0000000..ad3d412
--- /dev/null
+++ b/docs/mndp.1
@@ -0,0 +1,22 @@
+.TH MNDP 1 "February 27, 2011"
+.SH NAME
+mndp \- A tool for discovering other RouterOS or mactelnetd devices
+.SH SYNOPSIS
+.B mndp
+.SH DESCRIPTION
+This tool enables you to discover RouterOS or MAC-Telnetd enabled
+devices. It will display the MAC-address software version, and uptime of
+every device or machine it discovers.
+.PP
+To exit this application, use
+.B Control + C
+\.
+.SH SEE ALSO
+.BR mactelnet (1),
+.BR macping (1),
+.BR mactelnetd (1).
+.SH AUTHOR
+mndp was written by Håkon Nessjøen <haakon.nessjoen@gmail.com>.
+.PP
+This manual page was written by Håkon Nessjøen <haakon.nessjoen@gmail.com>,
+for the Debian project (and may be used by others).