313 lines
9.3 KiB
Groff
313 lines
9.3 KiB
Groff
.\" $Id: mdnsproxy.8.in,v 1.1 2001/06/09 00:30:35 tale Exp $
|
|
.\"
|
|
.\" Copyright (c) 2000 Japan Network Information Center. All rights reserved.
|
|
.\"
|
|
.\" By using this file, you agree to the terms and conditions set forth bellow.
|
|
.\"
|
|
.\" LICENSE TERMS AND CONDITIONS
|
|
.\"
|
|
.\" The following License Terms and Conditions apply, unless a different
|
|
.\" license is obtained from Japan Network Information Center ("JPNIC"),
|
|
.\" a Japanese association, Fuundo Bldg., 1-2 Kanda Ogawamachi, Chiyoda-ku,
|
|
.\" Tokyo, Japan.
|
|
.\"
|
|
.\" 1. Use, Modification and Redistribution (including distribution of any
|
|
.\" modified or derived work) in source and/or binary forms is permitted
|
|
.\" under this License Terms and Conditions.
|
|
.\"
|
|
.\" 2. Redistribution of source code must retain the copyright notices as they
|
|
.\" appear in each source code file, this License Terms and Conditions.
|
|
.\"
|
|
.\" 3. Redistribution in binary form must reproduce the Copyright Notice,
|
|
.\" this License Terms and Conditions, in the documentation and/or other
|
|
.\" materials provided with the distribution. For the purposes of binary
|
|
.\" distribution the "Copyright Notice" refers to the following language:
|
|
.\" "Copyright (c) Japan Network Information Center. All rights reserved."
|
|
.\"
|
|
.\" 4. Neither the name of JPNIC may be used to endorse or promote products
|
|
.\" derived from this Software without specific prior written approval of
|
|
.\" JPNIC.
|
|
.\"
|
|
.\" 5. Disclaimer/Limitation of Liability: THIS SOFTWARE IS PROVIDED BY JPNIC
|
|
.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
|
|
.\" PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JPNIC BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
|
|
.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
|
|
.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
|
|
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
|
|
.\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
|
.\"
|
|
.\" 6. Indemnification by Licensee
|
|
.\" Any person or entities using and/or redistributing this Software under
|
|
.\" this License Terms and Conditions shall defend indemnify and hold
|
|
.\" harmless JPNIC from and against any and all judgements damages,
|
|
.\" expenses, settlement liabilities, cost and other liabilities of any
|
|
.\" kind as a result of use and redistribution of this Software or any
|
|
.\" claim, suite, action, litigation or proceeding by any third party
|
|
.\" arising out of or relates to this License Terms and Conditions.
|
|
.\"
|
|
.\" 7. Governing Law, Jurisdiction and Venue
|
|
.\" This License Terms and Conditions shall be governed by and and
|
|
.\" construed in accordance with the law of Japan. Any person or entities
|
|
.\" using and/or redistributing this Software under this License Terms and
|
|
.\" Conditions hereby agrees and consent to the personal and exclusive
|
|
.\" jurisdiction and venue of Tokyo District Court of Japan.
|
|
.TH DNSPROXY 8
|
|
.SH NAME
|
|
mdnsproxy \- DNS proxy server for multi-lingual DNS
|
|
|
|
.SH SYNOPSIS
|
|
.B mdnsproxy
|
|
[ \-daemon ] [ \-config <config\-file> ] [ \-logfile <log\-file> ]
|
|
.br
|
|
.B mdnsproxy
|
|
\-version
|
|
|
|
.SH DESCRIPTION
|
|
.B mdnsproxy
|
|
resides between application (resolver) and DNS server.
|
|
.PP
|
|
It accepts DNS requests from application (resolver) and converting
|
|
domain names in those requests into DNS server's acceptable encoding,
|
|
and forward those converted requests. It also accepts responses from
|
|
DNS server and converting domain names in those resopnses into
|
|
application's acceptable encoding and forward those responses to
|
|
applications.
|
|
|
|
.SH OPTIONS
|
|
.TP
|
|
.B \-daemon
|
|
Run mdnsproxy as daemon. Otherwise, mdnsproxy will run as normal
|
|
console program.
|
|
.TP
|
|
.B \-config <config\-file>
|
|
Specifies configuration file (see later). If not specified,
|
|
mdnsproxy uses default configuration file.
|
|
See
|
|
.B FILES
|
|
section for default configuration file.
|
|
.TP
|
|
.B \-logfile <log\-file>
|
|
Specifies logging file. If not specified.
|
|
mdnsproxy uses default logging file.
|
|
See
|
|
.B FILES
|
|
section for default configuration file.
|
|
.TP
|
|
.B \-version
|
|
Prints version information to standard error and quits.
|
|
|
|
.SH CONFIGURATION
|
|
Configuration file is simple text file which defines several
|
|
configuration data.
|
|
.IP "listen <address>"
|
|
.RS
|
|
Defines listening port (both TCP and UDP). <address> is one of
|
|
.RS
|
|
.PP
|
|
<IP address>:<port number>
|
|
.br
|
|
:<port number>
|
|
.br
|
|
<IP address>
|
|
.PP
|
|
.RE
|
|
If omitted, mdnsproxy uses default value shown below.
|
|
.RS
|
|
.PP
|
|
IP Address INADDR_ANY (0.0.0.0)
|
|
.br
|
|
port number 53
|
|
.PP
|
|
.RE
|
|
.RE
|
|
.IP "forward <address> [ bind4compat ]"
|
|
.RS
|
|
Defines forwarding server's address. Format is same as 'listen'.
|
|
.PP
|
|
example:
|
|
.RS
|
|
forward 10.1.2.3
|
|
.RE
|
|
.PP
|
|
If "bind4compat" was given, mdnsproxy uses above listen port
|
|
as forwading UDP's source address. If not given, mdnsproxy uses
|
|
port > 1024 as forwading UDP's source.
|
|
.RE
|
|
.IP "client-encoding <Encoding>"
|
|
.RS
|
|
Defines client side character encoding scheme.
|
|
.PP
|
|
example:
|
|
.RS
|
|
.nf
|
|
client-encoding\ \ EUC-JP
|
|
.fi
|
|
.RE
|
|
.RE
|
|
.IP "mdn-conf-file <path>"
|
|
.RS
|
|
Specifies configuration file for libmdn, the library responsible for most
|
|
of the MDN processing for mdnsproxy.
|
|
If the entry is ommitted, mdnsproxy reads "@sysconfdir@/mdn.conf".
|
|
.RE
|
|
.IP "log-file <path>"
|
|
.RS
|
|
Defines log file name. It may be overridden with command line
|
|
option '-logfile <path>'. If no log file given, mdnsproxy writes
|
|
log data into "@logdir@/mdnsproxy.log".
|
|
Sending SIGHUP causes mdnsproxy to close the log file and then reopen it.
|
|
.PP
|
|
If <path> is set to ``syslog'', mdnsproxy outputs log messages with
|
|
syslog.
|
|
.RE
|
|
.IP "log-level <Level>"
|
|
.RS
|
|
Sets the log level. Available levels are ``none'' (no logging at all),
|
|
``fatal'' (only logs fatal errors), ``warn'' (also logs warning messages)
|
|
and ``trace'' (also includes trace level messages). The default level is
|
|
``warn''. Please note that if you set the level to ``trace'', the size of
|
|
the log file grows quickly.
|
|
.PP
|
|
If mdnsproxy is configured to output log messages with syslog (see the
|
|
description of the ``log-file'' entry), ``fatal'' messages are output
|
|
with ``err'' priority, ``warning'' messages with ``warning'' and ``trace''
|
|
messages with ``debug''.
|
|
.RE
|
|
.IP "mdn-log-level <Number>"
|
|
.RS
|
|
Specifies the logging level for libmdn.
|
|
Unless you are debugging mDNkit, you should keep this entry unspecified.
|
|
.RE
|
|
.IP "syslog-facility <Facility>"
|
|
.RS
|
|
Specifies the syslog facility to be assigned to log messages output by
|
|
mdnsproxy. The entry is ignored unless the `log-file' entry is set to
|
|
``syslog''. If the entry is not specified, ``daemon'' will be used.
|
|
|
|
.RE
|
|
.IP "user-id <Name-or-ID>"
|
|
.RS
|
|
Defines a user ID in which mdnsproxy operates.
|
|
Dnsproxy tries to change the user ID of its process to the specified one,
|
|
soon after initialization.
|
|
.PP
|
|
example:
|
|
.RS
|
|
.nf
|
|
user-id\ \ nobody
|
|
user-id\ \ 9999
|
|
.fi
|
|
.RE
|
|
.PP
|
|
It is strongly recommended to use this option for security reasons.
|
|
.RE
|
|
.IP "group-id <Name-or-ID>"
|
|
.RS
|
|
Defines a group ID in which mdnsproxy operates.
|
|
Dnsproxy tries to change the group ID of its process to the specified one,
|
|
soon after initialization.
|
|
.PP
|
|
example:
|
|
.RS
|
|
.nf
|
|
group-id\ \ nobody
|
|
group-id\ \ 9999
|
|
.fi
|
|
.RE
|
|
.RE
|
|
.IP "root-directory <Directory>"
|
|
.RS
|
|
Defines the pathname of the root directory for the mdnsproxy process.
|
|
Dnsproxy performs chroot() to set the specified directory as the
|
|
root directory for the process after initialization.
|
|
.PP
|
|
example:
|
|
.RS
|
|
.nf
|
|
root-directory /var/mdnsproxy
|
|
.fi
|
|
.RE
|
|
.RE
|
|
.IP "allow-access <Address> ..."
|
|
.RS
|
|
Specifies which hosts are allowed to access to the server.
|
|
<Address> is an IP address (in dotted numeric form) or IP prefix
|
|
(IP address followed by a slash and netmask).
|
|
.PP
|
|
example:
|
|
.RS
|
|
.nf
|
|
allow-access 192.168.100.1
|
|
allow-access 192.168.10.0/24
|
|
.fi
|
|
.RE
|
|
.PP
|
|
You can specify one or more <Address>. The server rejects accesses
|
|
from clients not matched to any <Address>.
|
|
You can also define allow-access several times.
|
|
.PP
|
|
.RS
|
|
.nf
|
|
allow-access 192.168.100.1
|
|
allow-access 192.168.100.2
|
|
.fi
|
|
.RE
|
|
.PP
|
|
This is equivarent to:
|
|
.PP
|
|
.RS
|
|
.nf
|
|
allow-access 192.168.100.1 192.168.100.2
|
|
.fi
|
|
.RE
|
|
.PP
|
|
If no entry is specified, the server allows to access from all hosts.
|
|
.RE
|
|
.IP "log-on-denied <Flag>"
|
|
.RS
|
|
is used to tell mdnsproxy whether or not to log denied access.
|
|
<Flag> is either "yes" or "no".
|
|
If "yes" is specified, the server records denied access.
|
|
The default value is "no".
|
|
.RE
|
|
.RE
|
|
|
|
.SH NOTES
|
|
Some applications locally mangles domain names. In those cases,
|
|
mdnsproxy cannot works correctly.
|
|
.PP
|
|
For 'nslookup', it generally reject non-ascii domain names.
|
|
You need 8bit through patched version of nslookup.
|
|
.PP
|
|
For UNIX resolver generally rejects domain names using non-ascii characters.
|
|
You need 8bit through patched version of resolver.
|
|
.PP
|
|
For Windows, NS works well with mdnsproxy. For IE, turn off "use UTF-8"
|
|
setting, and generally works. But for IE, embedded URL's in page will
|
|
converted by IE (to page's original encoding),
|
|
and they conflict with mdnsproxy.
|
|
|
|
.SH FILES
|
|
.PD 0
|
|
.TP
|
|
.B @sysconfdir@/mdnsproxy.conf
|
|
Default configuration file for mdnsproxy.
|
|
.TP
|
|
.B @sysconfdir@/mdn.conf
|
|
Default configuration file for libmdn.
|
|
.TP
|
|
.B @logdir@/mdnsproxy.log
|
|
Default logging file.
|
|
.PD
|
|
|
|
.SH SLL ALSO
|
|
.BR named(8),
|
|
.BR syslogd(8),
|
|
.BR syslog.conf(5),
|
|
.BR libmdn(3),
|
|
.BR iconv(3)
|