xref: /freebsd/usr.bin/ssh-copy-id/ssh-copy-id.1 (revision e1e636193db45630c7881246d25902e57c43d24e)
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.Dd February 28, 2014
26.Dt SSH-COPY-ID 1
27.Os
28.Sh NAME
29.Nm ssh-copy-id
30.Nd copy public keys to a remote host
31.Sh SYNOPSIS
32.Nm
33.Op Fl lv
34.Op Fl i Ar keyfile
35.Op Fl o Ar option
36.Op Fl p Ar port
37.Oo Ar user Ns @ Oc Ns Ar hostname
38.Sh DESCRIPTION
39The
40.Nm
41utility copies public keys to a remote host's
42.Pa ~/.ssh/authorized_keys
43file (creating the file and directory, if required).
44.Pp
45The following options are available:
46.Bl -tag -width indent
47.It Fl i Ar file
48Copy the public key contained in
49.Ar file .
50This option can be specified multiple times and can be combined with
51the
52.Fl l
53option.
54If a private key is specified and a public key is found then the public key
55will be used.
56.It Fl l
57Copy the keys currently held by
58.Xr ssh-agent 1 .
59This is the default if the
60.Fl i
61option was not specified.
62.It Fl o Ar ssh-option
63Pass this option directly to
64.Xr ssh 1 .
65This option can be specified multiple times.
66.It Fl p Ar port
67Connect to the specified port on the remote host instead of the
68default.
69.It Fl v
70Pass -v to
71.Xr ssh 1 .
72.El
73.Pp
74The remaining arguments are a list of remote hosts to connect to,
75each one optionally qualified by a user name.
76.Sh EXIT STATUS
77.Ex -std
78.Sh EXAMPLES
79To send a specific key to multiple hosts:
80.Dl $ ssh-copy-id -i /path/to/keyfile.pub user@host1 user@host2 user@host3
81.Sh HISTORY
82The
83.Nm
84utility was written by
85.An Eitan Adler Aq Mt eadler@FreeBSD.org
86as a drop-in replacement for an existing utility included with
87OpenSSH.
88