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