- Big manpage and config file cleanup from Andre Lucas

[openssh.git] / sshd.8

diff --git a/sshd.8.in b/sshd.8
similarity index 97%
rename from sshd.8.in
rename to sshd.8
index a7c0e4d2c6b4def82e15e22287fe898cb0551a41..437ff101b3942aac1764b38ed2e4ed85dff7fdc6 100644 (file)
--- a/sshd.8.in
+++ b/sshd.8
@@ -123,7 +123,7 @@ not fork and will only process one connection.  This option is only
 intended for debugging for the server.
 .It Fl f Ar configuration_file
 Specifies the name of the configuration file.  The default is
-.Pa @sysconfdir@/sshd_config .
+.Pa /etc/sshd_config .
 .Nm
 refuses to start if there is no configuration file.
 .It Fl g Ar login_grace_time
@@ -133,7 +133,7 @@ this many seconds, the server disconnects and exits.  A value of zero
 indicates no limit.
 .It Fl h Ar host_key_file
 Specifies the file from which the host key is read (default
-.Pa @sysconfdir@/ssh_host_key ) .
+.Pa /etc/ssh_host_key ) .
 This option must be given if
 .Nm
 is not run as root (as the normal
@@ -185,7 +185,7 @@ to use IPv6 addresses only.
 .Sh CONFIGURATION FILE
 .Nm
 reads configuration data from 
-.Pa @sysconfdir@/sshd_config
+.Pa /etc/sshd_config
 (or the file specified with
 .Fl f
 on the command line).  The file
@@ -253,7 +253,7 @@ id isn't recognized.  By default login is allowed regardless of
 the user name.
 .It Cm HostKey
 Specifies the file containing the private host key (default
-.Pa @sysconfdir@/ssh_host_key ) .
+.Pa /etc/ssh_host_key ) .
 Note that
 .Nm
 does not start if this file is group/world-accessible.
@@ -262,7 +262,7 @@ Specifies that rhosts and shosts files will not be used in
 authentication.
 .Pa /etc/hosts.equiv
 and
-.Pa @sysconfdir@/shosts.equiv 
+.Pa /etc/shosts.equiv 
 are still used.  The default is 
 .Dq no .
 .It Cm IgnoreUserKnownHosts
@@ -483,7 +483,7 @@ Changes to user's home directory.
 If
 .Pa $HOME/.ssh/rc
 exists, runs it; else if
-.Pa @sysconfdir@/sshrc
+.Pa /etc/sshrc
 exists, runs
 it; otherwise runs xauth.  The
 .Dq rc
@@ -569,7 +569,7 @@ from="*.niksula.hut.fi,!pc.niksula.hut.fi" 1024 35 23.\|.\|.\|2334 ylo@niksula
 command="dump /home",no-pty,no-port-forwarding 1024 33 23.\|.\|.\|2323 backup.hut.fi
 .Sh SSH_KNOWN_HOSTS FILE FORMAT
 The 
-.Pa @sysconfdir@/ssh_known_hosts
+.Pa /etc/ssh_known_hosts
 and 
 .Pa $HOME/.ssh/known_hosts
 files contain host public keys for all known hosts.  The global file should
@@ -592,7 +592,7 @@ pattern on the line.
 .Pp
 Bits, exponent, and modulus are taken directly from the host key; they
 can be obtained, e.g., from
-.Pa @sysconfdir@/ssh_host_key.pub .
+.Pa /etc/ssh_host_key.pub .
 The optional comment field continues to the end of the line, and is not used.
 .Pp
 Lines starting with
@@ -611,25 +611,25 @@ Note that the lines in these files are typically hundreds of characters
 long, and you definitely don't want to type in the host keys by hand.
 Rather, generate them by a script
 or by taking 
-.Pa @sysconfdir@/ssh_host_key.pub
+.Pa /etc/ssh_host_key.pub
 and adding the host names at the front.
 .Ss Examples
 closenet,closenet.hut.fi,.\|.\|.\|,130.233.208.41 1024 37 159.\|.\|.93 closenet.hut.fi
 .Sh FILES
 .Bl -tag -width Ds
-.It Pa @sysconfdir@/sshd_config
+.It Pa /etc/sshd_config
 Contains configuration data for
 .Nm sshd .
 This file should be writable by root only, but it is recommended
 (though not necessary) that it be world-readable.
-.It Pa @sysconfdir@/ssh_host_key
+.It Pa /etc/ssh_host_key
 Contains the private part of the host key.
 This file should only be owned by root, readable only by root, and not
 accessible to others.
 Note that
 .Nm
 does not start if this file is group/world-accessible.
-.It Pa @sysconfdir@/ssh_host_key.pub
+.It Pa /etc/ssh_host_key.pub
 Contains the public part of the host key.
 This file should be world-readable but writable only by
 root.  Its contents should match the private part.  This file is not
@@ -637,7 +637,7 @@ really used for anything; it is only provided for the convenience of
 the user so its contents can be copied to known hosts files.
 These two files are created using
 .Xr ssh-keygen 1 .
-.It Pa @piddir@/sshd.pid
+.It Pa /var/run/sshd.pid
 Contains the process ID of the
 .Nm
 listening for connections (if there are several daemons running
@@ -650,14 +650,14 @@ This file must be readable by root (which may on some machines imply
 it being world-readable if the user's home directory resides on an NFS
 volume).  It is recommended that it not be accessible by others.  The
 format of this file is described above.
-.It Pa "@sysconfdir@_known_hosts" and "$HOME/.ssh/known_hosts"
+.It Pa "/etc/ssh_known_hosts" and "$HOME/.ssh/known_hosts"
 These files are consulted when using rhosts with RSA host
 authentication to check the public key of the host.  The key must be
 listed in one of these files to be accepted.
 The client uses the same files
 to verify that the remote host is the one we intended to
 connect. These files should be writable only by root/the owner.
-.Pa @sysconfdir@/ssh_known_hosts
+.Pa /etc/ssh_known_hosts
 should be world-readable, and
 .Pa $HOME/.ssh/known_hosts
 can but need not be world-readable.
@@ -719,7 +719,7 @@ user root access.  The only valid use for user names that I can think
 of is in negative entries.
 .Pp
 Note that this warning also applies to rsh/rlogin.
-.It Pa @sysconfdir@/shosts.equiv
+.It Pa /etc/shosts.equiv
 This is processed exactly as
 .Pa /etc/hosts.equiv .
 However, this file may be useful in environments that want to run both
@@ -749,13 +749,13 @@ something similar to: "if read proto cookie; then echo add $DISPLAY
 $proto $cookie | xauth -q -; fi".
 .Pp
 If this file does not exist,
-.Pa @sysconfdir@/sshrc
+.Pa /etc/sshrc
 is run, and if that
 does not exist either, xauth is used to store the cookie.
 .Pp
 This file should be writable only by the user, and need not be
 readable by anyone else.
-.It Pa @sysconfdir@/sshrc
+.It Pa /etc/sshrc
 Like
 .Pa $HOME/.ssh/rc .
 This can be used to specify