xref: /freebsd/usr.bin/ssh-copy-id/ssh-copy-id.1 (revision f39bffc62c1395bde25d152c7f68fdf7cbaab414)
1.\"-
2.\" Copyright (c) 2012 Eitan Adler
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd February 28, 2014
28.Dt SSH-COPY-ID 1
29.Os
30.Sh NAME
31.Nm ssh-copy-id
32.Nd copy public keys to a remote host
33.Sh SYNOPSIS
34.Nm
35.Op Fl lv
36.Op Fl i Ar keyfile
37.Op Fl o Ar option
38.Op Fl p Ar port
39.Oo Ar user Ns @ Oc Ns Ar hostname
40.Sh DESCRIPTION
41The
42.Nm
43utility copies public keys to a remote host's
44.Pa ~/.ssh/authorized_keys
45file (creating the file and directory, if required).
46.Pp
47The following options are available:
48.Bl -tag -width indent
49.It Fl i Ar file
50Copy the public key contained in
51.Ar file .
52This option can be specified multiple times and can be combined with
53the
54.Fl l
55option.
56If a private key is specified and a public key is found then the public key
57will be used.
58.It Fl l
59Copy the keys currently held by
60.Xr ssh-agent 1 .
61This is the default if the
62.Fl i
63option was not specified.
64.It Fl o Ar ssh-option
65Pass this option directly to
66.Xr ssh 1 .
67This option can be specified multiple times.
68.It Fl p Ar port
69Connect to the specified port on the remote host instead of the
70default.
71.It Fl v
72Pass -v to
73.Xr ssh 1 .
74.El
75.Pp
76The remaining arguments are a list of remote hosts to connect to,
77each one optionally qualified by a user name.
78.Sh EXIT STATUS
79.Ex -std
80.Sh EXAMPLES
81To send a specific key to multiple hosts:
82.Dl $ ssh-copy-id -i /path/to/keyfile.pub user@host1 user@host2 user@host3
83.Sh HISTORY
84The
85.Nm
86utility was written by
87.An Eitan Adler Aq Mt eadler@FreeBSD.org
88as a drop-in replacement for an existing utility included with
89OpenSSH.
90