.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH MKUSERS 8 "March  12, 2002"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
MkUsers \- Batch creating multiple XMail accounts
.SH SYNOPSIS
.B MkUsers
.RI [ options ]
.SH DESCRIPTION
This command line utility enable You to
create user accounts structure by giving it a formatted list of
users parameters or a formatted text file.
This utility can be also used to create a random number users,
that is useful for me for testing the server performance.
.SH OPTIONS
.TP
.B \-a numusers
Number of users to create in auto-mode.
.TP
.B \-d domain
Domain name in auto-mode.
.TP
.B \-f inputFile
Input file name {stdin}.
.TP
.B \-u username
Radix user name in auto-mode.
.TP
.B \-r rootdir
Mail root path {./}.
.TP
.B \-s mboxsize
Mailbox maximum size {10000}.
.TP
.B \-i useridbase
Base user id {1}.
.TP
.B \-m 
Create Maildir boxes.
.TP
.B \-h
show help message.
.SH USAGE
Input file format is
.P
.B domain;username;password;real-name;homepage[NEWLINE]
.P
where a character # as the very first one in a line is used to comment the entire line.
.P
If a file mailusers.tab already exist in mail root path MkUsers exit without
overwriting the existing copy.
This protect You by accidental overwriting of Your file when playing inside
the real MAIL_ROOT directory.
So if You want to setup the root directory ( \-r ... ) as MAIL_ROOT
You must delete by hand the existing file.
If You setup the root directory ( \-r ... ) as MAIL_ROOT You MUST have
XMail stopped before running MkUsers.
Existing files and directories will be not overwrited by MkUsers so
You can keep Your users db into the formatted text file
( or generate it by a database dump for example ) and run MkUsers to
create the structure. Remeber that You've to add new domains in domains.tab
file by hand. 
.SH NOTES
MkUsers is intended as a bulk-mode utility, not to create single users coz for this need CtrlClnt ( or other GUI/Web configuration utilities ) is better suited.
.SH SEE ALSO
.BR CtrlClnt (1),
.BR XMail (8).
.SH AUTHOR
XMail program was written by Davide Libenzi <davidel@xmailserver.org>.
This manual page was written by Radim Kolar <hsn@cybermail.net>,
for the Debian GNU/Linux system (but may be used by others).