." -*- nroff -*-
."  Copyright 2005 Laurent Wacrenier
."
."  This file is part of libhome
."
."  libhome is free software; you can redistribute it and/or modify it
."  under the terms of the GNU Lesser General Public License as
."  published by the Free Software Foundation; either version 2 of the
."  License, or (at your option) any later version.
."
."  libhome 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 Lesser General Public License for more details.
."
."  You should have received a copy of the GNU Lesser General Public
."  License along with libhome; if not, write to the Free Software
."  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
."  USA
."
." $Id: home_proxy.8,v 1.7 2005/07/01 09:52:01 lwa Exp $
."
.TH home_proxy 8 "Feb 4 2005"

.SH NAME

.B home_proxy
- proxy server for libhome

.SH SYNOPSIS

.B home_proxy
[
.B -xdv
] [
.B -s
.I path
] [
.B -C
.I file
] [
.B -t
.I tag
] [
.B -n
.I num
] [
.B -k
.I seconds
] [
.B -u
.I uid
] [
.B -g 
.I gid
] [
.B -m mode
]

.SH DESCRIPTION
\fBhome_proxy\fP is a proxy to for the \fIproxy\fP libhome mode.

The following options are available: 
.SH

.TP
.B -s \fIpath\fP
Listen the unix socket \fIpath\fP.
Default is read from the \fBproxy_socket\fP directive in the
configuration file.

.TP
.B -x
Unlink the socket before binding when it's already used.

.TP
.B -C \fIfile\fP
Use an alternate config home.conf(5) file instead of default

.TP
.B -t \fItag\fP
Set the libhome \fItag\fP

.TP
.B -n \fInum\fP
Prefork \fInum\fP deamons. Default is 1.

.TP
.B -k \fIsec\fP
Kill one different deamon child each \fIsec\fP second
and restart it.

.TP
.B -p \fIfile\fP
Write the process ID in the specified \fIfile\fP.

.TP
.B -d
Don't detach at startup.

.TP
.B -u \fIuid\fP
Set the user id of the socket to \fIuid\fP (in decimal) 

.TP
.B -g \fIgid\fP
Set the group id of the socket to \fIuid\fP (in decimal) 

.TP
.B -m \fImode\fP
Set the mode of the socket to \fImode\fP (in octal) 

.TP
.B -v
Log verbosly. More than one 
.B -v 
may be set. On verbose level 2, results of request are logged.

.SH SIGNALS

.TP
.B SIGTERM
.B SIGINT
Unlink the socket path and terminate the deamon.

.B SIGHUP
Read the configuration file again and restart the servers.
If the socket path need to be changed, the new socket will be open
and the old one will be closed.

.SH LOGGING
Errors conditions are sent to syslog using the "auth" facility.

.SH NAME SERVICE SWITCH

For the system who support it, it's possible to use home_proxy as
source for the NSS dispatcher.
Add domething like that in your /etc/nsswitch.conf file:

 passwd: files home_proxy

Warn to not set direct access to system password in your libhome.conf
file.

The dispatcher as no confiruration file, it expect to connect 
to the proxy using the socket at /var/run/home_proxy.

Currently, it has been tested on FreeBSD and Linux only.

.SH FILES
.TP 
/usr/local/etc/home.conf
Default configuration file unless compiled otherwise.

.TP
/var/run/home_proxy
Fallback socket path

.TP
nss_home_proxy.so.1
NSS library

.SH BUGS
Theyre is no loop detection. Warn to not proxy to the proxy itself.

Logins are limited to 1000 characters.

Access permission on caller effective user or group ID, granted by
\fBproxy.deny\fP directive work only on some systems.  Linux 2.2,
FreeBSD 4.6, OpenBSD 3.0, Mac OS X, AIX 5L, NetBSD 1.4 and later
should work. HPUX, Solaris probably not. Solaris implementation may be
donne with some efforts. A warning at compile time will notify when
this feature is unavaiable. Not all systems have been tested.

.SH SEE ALSO
home.conf(5), nsswitch.conf(5)

http://pll.sourceforge.net/

.SH AUTHOR
Laurent Wacrenier \fC<lwa@teaser.fr>\fP