Outsource creation of random MAC address to a new function create_random_mac.
[mausezahn.git] / doc / mz.cfg.1
blobcf0c15efd64492558a1d606e1bc50ee335299e9c
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH mz.cfg 1 "March 7, 2010"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 mz \- a fast versatile packet generator
20 .SH SYNOPSIS
21 .B /etc/mausezahn/mz.cfg
22 .br
23 .SH DESCRIPTION
24 .PP
25 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
26 .\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
27 .\" respectively.
28 \fBMausezahn\fP is a free fast traffic generator written in C which allows 
29 you to send nearly every possible and impossible packet. Mausezahn's MOPS
30 subsystem (Mausezahn's Own Packet System) supports an interactive mode with
31 a Cisco-style command line interface (CLI). In order to activate this
32 interactive mode, execute Mausezahn using the \fI-x\fP argument, optionally
33 followed by an arbitrary TCP port number, such as
34 .PP
35 # mz \-x 99
36 .PP
37 in which case you can connect to Mausezahn via
38 .PP
39 $ telnet 127.0.0.1 99
40 .PP
41 If no port number is specified, Mausezahn uses the default port number 25542
42 (which is the date of towel day followed by the answer to the universe and 
43 everything; however, you don't need to understand this in order to continue).
44 .PP
45 Login credentials as well as other
46 MOPS-related parameters can be specified in the Mausezahn configuration file
47 \fImz.cfg\fP located in \f/etc/mausezahn\fP. Currently, user-specific 
48 configuration files are not supported.
49 .PP
50 If no configuration file is present Mausezahn assumes the following default login
51 credentials:
52 .TP
53 .PP
54 username: mz
55 .br
56 password: mz
57 .br
58 enable password: mops
59 .PP
61 Currently only login credentials can be configured within the configuration
62 file. Here is an example content of \fI/etc/mausezahn/mz.cfg\fP:
63 .TP
64 .PP
65 user = herbert
66 .br
67 password = moTTe
68 .br
69 enable = T0p5ecreT
70 .PP
71 Additional configuration options will be officially supported with the next
72 releases.
73 .SH FILES
74 \fI/etc/mausezahn/mz.cfg\fP
75 .SH SEE ALSO
76  \fBmz(1)\fP
77 .SH AUTHOR
78 Herbert Haas. 
79 .PP
80 Visit www.perihel.at/sec/mz/ for Mausezahn news and additional information.
81 .PP
82 This manual page was written by Herbert Haas <herbert AT perihel DOT at>,
83 for the Debian project.