contrib/subversion/subversion/svnserve/svnserve.8

   1 .\"
   2 .\"
   3 .\"     Licensed to the Apache Software Foundation (ASF) under one
   4 .\"     or more contributor license agreements.  See the NOTICE file
   5 .\"     distributed with this work for additional information
   6 .\"     regarding copyright ownership.  The ASF licenses this file
   7 .\"     to you under the Apache License, Version 2.0 (the
   8 .\"     "License"); you may not use this file except in compliance
   9 .\"     with the License.  You may obtain a copy of the License at
  10 .\"
  11 .\"       http://www.apache.org/licenses/LICENSE-2.0
  12 .\"
  13 .\"     Unless required by applicable law or agreed to in writing,
  14 .\"     software distributed under the License is distributed on an
  15 .\"     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  16 .\"     KIND, either express or implied.  See the License for the
  17 .\"     specific language governing permissions and limitations
  18 .\"     under the License.
  19 .\"
  20 .\"
  21 .\" You can view this file with:
  22 .\" nroff -man [filename]
  23 .\"
  24 .TH svnserve 8
  25 .SH NAME
  26 svnserve \- Server for the 'svn' repository access method
  27 .SH SYNOPSIS
  28 .TP
  29 \fBsvnserve\fP [\fIoptions\fP]
  30 .SH DESCRIPTION
  31 \fBsvnserve\fP allows access to Subversion repositories using the svn
  32 network protocol.  It can both run as a standalone server process, or
  33 it can run out of inetd.  You must choose a mode of operation when you
  34 start \fBsvnserve\fP.  The following options are recognized:
  35 .PP
  36 .TP 5
  37 \fB\-d\fP, \fB\-\-daemon\fP
  38 Causes \fBsvnserve\fP to run in daemon mode.  \fBsvnserve\fP
  39 backgrounds itself and accepts and serves TCP/IP connections on the
  40 svn port (3690, by default).
  41 .PP
  42 .TP 5
  43 \fB\-\-listen\-port\fP=\fIport\fP
  44 Causes \fBsvnserve\fP to listen on \fIport\fP when run in daemon mode.
  45 .PP
  46 .TP 5
  47 \fB\-\-listen\-host\fP=\fIhost\fP
  48 Causes \fBsvnserve\fP to listen on the interface specified by \fIhost\fP,
  49 which may be either a hostname or an IP address.
  50 .PP
  51 .TP 5
  52 \fB\-\-foreground\fP
  53 When used together with \fB\-d\fP, this option causes \fBsvnserve\fP
  54 to stay in the foreground.  This option is mainly useful for
  55 debugging.
  56 .PP
  57 .TP 5
  58 \fB\-i\fP, \fB\-\-inetd\fP
  59 Causes \fBsvnserve\fP to use the stdin/stdout file descriptors, as is
  60 appropriate for a daemon running out of inetd.
  61 .PP
  62 .TP 5
  63 \fB\-h\fP, \fB\-\-help\fP
  64 Displays a usage summary and exits.
  65 .PP
  66 .TP 5
  67 \fB\-\-version\fP
  68 Print \fBsvnserve\fP's version and the repository filesystem
  69 back-end(s) a particular \fBsvnserve\fP supports.
  70 .PP
  71 .TP 5
  72 \fB\-r\fP \fIroot\fP, \fB\-\-root\fP=\fIroot\fP
  73 Sets the virtual root for repositories served by \fBsvnserve\fP.  The
  74 pathname in URLs provided by the client will be interpreted relative
  75 to this root, and will not be allowed to escape this root.
  76 .PP
  77 .TP 5
  78 \fB\-R\fP \fB\-\-read\-only\fP
  79 Force all write operations through this \fBsvnserve\fP instance to be
  80 forbidden, overriding all other access policy configuration.  Do not
  81 use this option to set general repository access policy - that is what
  82 the \fBconf/svnserve.conf\fP repository configuration file is for.
  83 This option should be used only to restrict access via a certain
  84 method of invoking \fBsvnserve\fP - for example, to allow write access
  85 via SSH, but not via a \fBsvnserve\fP daemon, or to create a
  86 restricted SSH key which is only capable of read access.
  87 .PP
  88 .TP 5
  89 \fB\-t\fP, \fB\-\-tunnel\fP
  90 Causes \fBsvnserve\fP to run in tunnel mode, which is just like the
  91 inetd mode of operation (serve one connection over stdin/stdout)
  92 except that the connection is considered to be pre-authenticated with
  93 the username of the current uid.  This flag is selected by the client
  94 when running over a tunnel agent.
  95 .PP
  96 .TP 5
  97 \fB\-\-tunnel\-user\fP=\fIusername\fP
  98 When combined with \fB\-\-tunnel\fP, overrides the pre-authenticated
  99 username with the supplied \fIusername\fP.  This is useful in
 100 combination with the ssh authorized_key file's "command" directive to
 101 allow a single system account to be used by multiple committers, each
 102 having a distinct ssh identity.
 103 .PP
 104 .TP 5
 105 \fB\-T\fP, \fB\-\-threads\fP
 106 When running in daemon mode, causes \fBsvnserve\fP to spawn a thread
 107 instead of a process for each connection.  The \fBsvnserve\fP process
 108 still backgrounds itself at startup time.
 109 .PP
 110 .TP 5
 111 \fB\-\-config\-file\fP=\fIfilename\fP
 112 When specified, \fBsvnserve\fP reads \fIfilename\fP once at program
 113 startup and caches the \fBsvnserve\fP configuration.  The password
 114 and authorization configurations referenced from \fIfilename\fP will
 115 be loaded on each connection.  \fBsvnserve\fP will not read any
 116 per-repository \fBconf/svnserve.conf\fP files when this option is
 117 used.  See the \fBsvnserve.conf\fP(5) man page for details of the
 118 file format for this option.
 119 .PP
 120 .TP 5
 121 \fB\-\-pid\-file\fP=\fIfilename\fP
 122 When specified, \fBsvnserve\fP will write its process ID to
 123 \fIfilename\fP.
 124 .PP
 125 .TP 5
 126 \fB\-X\fP, \fB\-\-listen\-once\fP
 127 Causes \fBsvnserve\fP to accept one connection on the svn port, serve
 128 it, and exit.  This option is mainly useful for debugging.
 129 .PP
 130 Unless the \fB\-\-config\-file\fP option was specified on the command
 131 line, once the client has selected a repository by transmitting its
 132 URL, \fBsvnserve\fP reads a file named \fBconf/svnserve.conf\fP in the
 133 repository directory to determine repository-specific settings such as
 134 what authentication database to use and what authorization policies to
 135 apply.  See the \fBsvnserve.conf\fP(5) man page for details of that
 136 file format.
 137 .SH SEE ALSO
 138 .BR svnserve.conf (5)