.\"  $HeadURL$ $LastChangedRevision$
.TH MUMC 1 "SPPSYM_RELEASE_DATE_MAN"
.SH NAME
mumc \- multiuser Mutella client
.br
.ne 5
.SH SYNOPSIS
.B mumc
[
.B \-V
|
.B \-\-version
] [
.B \-v
|
.B \-\-verbose
|
.B \-d
.I level
|
.B \-\-debug=\fIlevel
] [
.B \-h
|
.B \-\-help
] [
.B \-p
|
.B \-\-list\-paths
] 
[
.B \-l 
.I login
|
.B \-\-login=\fIlogin
]
[
.B \-g 
.I group
|
.B \-\-group=\fIgroup
]
[
.B \-c 
.I command
|
.B \-s
] [
.B \-f
.I file
|
.B \-\-config\-file=\fIfile
] [
.B \-m
.I cmd
|
.B \-\-mutella=\fIcmd
] [
.B \-\-foreground
] 
[
.B \-\-upload\-dir=\fIdir\fR
]
[
.B \-\-download\-dir=\fIdir\fR
]
.br
.ne 5
.SH DESCRIPTION
.B Mumc
acts as a front\-end to a single
.B mutella\fR(1)
process, allowing multiple users to communicate with it, somewhat
in the manner of a proxy.
.PP
.B Mumc
is started at boot-time by an 
.B init.d
script (see
.B init\fR(8)),
and run as a system user, not as any normal user.
.PP
.ne 5
.SH CONFIGURATION
.B Mumc 
runs 
.B mutella\fR(1)
under the user and group names
.B mutella\fR,
therefore these ids must be added to the passwd and group files
(or equivalent in NIS environments), before running.
.PP
.B Mumc
reads configuration directives from 
.B SPPSYM_CFGDIR/mumc.conf\fR. 
This file provides a way to make 
local configuration of either command line options or 
.B mutella\fR(1)
commands permanent. The usual rules of configuration files
regarding ignoring of blank lines, hash-led lines as comments and
line-splitting with backslashes apply. The possible directives are:
.TP 25
.B downloaddir: \fIdir\fR
Equivalent to the 
.B \-\-download\-dir
option.
.TP
.B mutellacmd1: \fIcmd1\fR, \fBmutellacmd2:\fR \fIcmd2\fR, ...
Equivalent to running the specified 
.B mutella\fR(1)
commands.
.TP
.B serverlogin: \fIlogin\fR
Equivalent to the 
.B \-\-login
option.
.TP
.B servergroup: \fIgroup\fR
Equivalent to the 
.B \-\-group
option.
.TP
.B uploaddir: \fIdir\fR
Equivalent to the
.B \-\-upload\-dir
option.
.ne 5
.SH OPTIONS
.TP 25
.B \-c \fIcommand
.B Mumc
operates in single-shot mode; it relays 
.I command
and then exits.
.TP
.B \-d \fIlevel\fR, \fB\-\-debug=\fIlevel\fR
Determines how verbose
.B mumc
will be. The message types displayed for the different values of 
.I level
are as follows:
.RS 25
.TP 5
.B 0
internal errors only
.TP
.B 1
internal errors and normal errors 
.TP
.B 2
internal errors, normal errors and warnings
.TP 
.B 3
internal errors, normal errors, warnings and informational messages
.TP 
.B >3
all the above plus application-specific debug messages.
.RE
.TP
.B \-\-download\-dir=\fIdir\fR
Sets the directory into which files are downloaded to
.I dir\fR.
.TP
.B \-f \fIfile\fR, \fB\-\-config\-file=\fIfile
Load the specified file in place of the default configuration
file
.B SPPSYM_CFGDIR/mumc.conf
.TP
.B \-\-foreground
The server process should not fork and detach from the
terminal.
.TP
.B \-g \fIgroup\fR, \fB\-\-group=\fIgroup
The server should run as 
.I group\fR.
.TP
.B \-h\fR, \fB\-\-help
Displays a brief usage message.
.TP
.B \-l \fIlogin\fR, \fB\-\-login=\fIlogin
The server should run as 
.I login
and the client should contact the server which is being run by
.I login\fR.
.TP
.B \-m \fIcmd\fR, \fB\-\-mutella=\fIcmd
The server process should run 
.I cmd
instead of
.B mutella\fR(1).
.TP
.B \-p\fR, \fB\-\-list\-paths
List the compiled-in paths of various files and directories that
.B mumc
uses.
.TP
.B \-s
Run as the proxy; 
.B mumc
starts
.B mutella\fR(1)
and detaches from the terminal.
.TP
.B \-\-upload\-dir=\fIdir\fR
Sets the directory from which files may be downloaded by others
to 
.I dir\fR.
If more than one directory is to be shared, then create a new single
directory containing symlinks to all the directories containing files
to be shared.
.TP 
.B \-v\fR, \fB\-\-verbose
Equivalent to
.B \-d 3\fR.
.TP
.B \-V\fR, \fB\-\-version
Print the program's version number and exit.
.br
.ne 5
.SH EXIT STATUS
On success
.B mumc
returns zero. On failure it returns non-zero and displays a diagnostic
message.
.br
.ne 5
.SH FILES
.TP 25
.B SPPSYM_CFGDIR/mumc.conf
Default configuration file
.TP
.B SPPSYM_LCKDIR/mumc.sock
Unix socket used as a communications channel between clients and
proxy
.TP
.B SPPSYM_LCKDIR/mumc.pid
Lock file used to prevent more than one server running, and in
which to register the server's process number.
.ne 5
.SH ENVIRONMENT VARIABLES
.TP 25 
.B PATH
.B Mumc
uses  
.B PATH
to locate
.B mutella\fR(1).
.br
.ne 5
.SH EXAMPLES
The following command might be used from an init.d script:
.IP
.nf
.fam C
.B mumc -s
.fam T
.fi
.br
.PP
Users could then either enter interactive sessions:
.IP
.nf
.fam C
.B mumc
.B find my_favourite_song mp3
.B ls
.B r 4
.B get 27-30
.fam T
.fi
.br
.PP
or run the same from the command line:
.IP
.nf
.fam C
.B mumc -c find my_favourite_song mp3
.B mumc -c ls
.B mumc -c r 4
.B mumc -c get 27-30
.fam T
.fi
.br
.ne 5
.SH CAVEATS
.B Mumc
uses Unix sockets (see
.B PF_UNIX\fR(7))
to connect the clients to the proxy which then relays requests
to the single
.B mutella\fR(1)
process, and forwards its replies. This means that clients must
run on the same system as the server.
.PP
.B Mumc
does not understand what a session is. This means
that a user issuing a search and list command sequence
between another user's search and retrieval will 
desynchronise that user's search result ids.
.PP
.B Mumc
modifies the effects of 
.B mutella\fR(1)'s
.B exit
and 
.B ls
commands; the first because this command means exit from
.B mumc\fR,
not from 
.B mutella\fR(1);
the second as a personal preference of the author.
.ne 5
.SH STANDARDS
This manual page documents version ADE_APP_TOKEN_RELEASE_ID of
.B mumc\fR.
.br
.ne 5
.SH SEE ALSO
mutella(1)
.br
.ne 5
.SH AUTHOR
SPPSYM_AUTHOR_NAME <SPPSYM_AUTHOR_EMAIL>
.br
.B Mumc
is loosely based on MUWI by Ralph Pape and Sebastian Ritterbusch.
.ne 5
.SH COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 2002-SPPSYM_RELEASE_YEAR SPPSYM_AUTHOR_NAME
.br
MUWI is Copyright (C) 2002, M.R. Pape, S. Ritterbusch
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.