Skip to content

Commit a0139d0

Browse files
Move mactelnetd man page to section 8 for admin commands
1 parent 7863199 commit a0139d0

3 files changed

Lines changed: 66 additions & 6 deletions

File tree

‎doc/Makefile.am‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
dist_man_MANS = mactelnet.1 mndp.1 macping.1
22

33
if BUILD_MACTELNETD
4-
dist_man_MANS += mactelnetd.1
5-
EXTRA_DIST = mactelnetd.1.in
6-
CLEANFILES = mactelnetd.1
4+
dist_man_MANS += mactelnetd.8
5+
EXTRA_DIST = mactelnetd.8.in
6+
CLEANFILES = mactelnetd.8
77

8-
mactelnetd.1: mactelnetd.1.in
9-
$(AM_V_GEN)$(SED) -e 's|@sysconfdir[@]|$(sysconfdir)|g' mactelnetd.1.in > $@
8+
mactelnetd.8: mactelnetd.8.in
9+
$(AM_V_GEN)$(SED) -e 's|@sysconfdir[@]|$(sysconfdir)|g' mactelnetd.8.in > $@
1010

11-
endif
11+
endif

‎doc/mactelnetd.8‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
.TH MACTELNETD 1 "February 27, 2011"
2+
.SH NAME
3+
mactelnetd \- Telnet daemon for MAC-address connections
4+
.SH SYNOPSIS
5+
.B mactelnetd
6+
.RI [ options ]
7+
.SH DESCRIPTION
8+
This daemon listens for telnet connections from Mikrotik RouterOS devices or mactelnet clients
9+
on the same physical network. It also announces it's hostname via the MNDP protocol every minute.
10+
.SH OPTIONS
11+
These programs follow the usual GNU command line syntax.
12+
A summary of options is included below.
13+
.TP
14+
.B \-n
15+
Do not use broadcast packets. A tad less insecure.
16+
This means that ethernet packets will have the mac-address of the client as the packet
17+
destination, instead of using the ethernet broadcast address.
18+
.TP
19+
.B \-o
20+
Use the older MD5 based authentication. This is less secure, and also requires your userfile to have the passwords in plaintext format. If you are running the server with this parameter, you cannot add users using the
21+
.B \-a
22+
option.
23+
.TP
24+
.B \-a
25+
Add a new user. The user should be an existing user in your system. This can be done without restarting your mactelnetd server as it re-reads the user file for each authentication attempt. You will be prompted for the username and password, or you can use one of the following options to specify them on the command line:
26+
.RS
27+
.TP
28+
.B \-u \fIusername\fR
29+
You can specify the new username to add on the command line using this option. If this is not used, you will be prompted for the username.
30+
.TP
31+
.B \-p \fIpassword\fR
32+
You can specify the new password for the new user to add on the command line using this option. If this is not used, you will be prompted for the password.
33+
.RE
34+
.TP
35+
.B \-d \fIusername\fR
36+
Delete the specified user.
37+
.TP
38+
.B \-l
39+
List the available users in the \fI/usr/local/etc/mactelnetd.users\fR file.
40+
.TP
41+
.B \-h
42+
Show summary of options.
43+
.TP
44+
.B \-v
45+
Show version of program.
46+
.SH FILES
47+
.TP
48+
.B /usr/local/etc/mactelnetd.users
49+
This file contains a line separated list of users that will have
50+
access to your machine. Usernames and passwords are separated
51+
by colon. This file is read each time a user connects.
52+
.SH SEE ALSO
53+
.BR mndp (1),
54+
.BR mactelnet (1),
55+
.BR macping (1).
56+
.SH AUTHOR
57+
mactelnetd was written by Håkon Nessjøen <haakon.nessjoen@gmail.com>.
58+
.PP
59+
This manual page was written by Håkon Nessjøen <haakon.nessjoen@gmail.com>,
60+
for the Debian project (and may be used by others).
File renamed without changes.

0 commit comments

Comments
 (0)