1 fb1a36c0 2022-01-09 op .\" Copyright (c) 2021 Omar Polo <op@omarpolo.com>
3 fb1a36c0 2022-01-09 op .\" Permission to use, copy, modify, and distribute this software for any
4 fb1a36c0 2022-01-09 op .\" purpose with or without fee is hereby granted, provided that the above
5 fb1a36c0 2022-01-09 op .\" copyright notice and this permission notice appear in all copies.
7 fb1a36c0 2022-01-09 op .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 fb1a36c0 2022-01-09 op .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 fb1a36c0 2022-01-09 op .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 fb1a36c0 2022-01-09 op .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 fb1a36c0 2022-01-09 op .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 fb1a36c0 2022-01-09 op .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 fb1a36c0 2022-01-09 op .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 2afde960 2022-11-23 op .Dd $Mdocdate: November 23 2022 $
23 fb1a36c0 2022-01-09 op .Op Fl C Ar cert
24 fb1a36c0 2022-01-09 op .Op Fl K Ar key
25 df9bb54d 2022-11-23 op .Op Fl o Ar output
26 2afde960 2022-11-23 op .Oo Ar user Ns @ Oc Ns Ar host Ns Oo : Ns Ar port Oc Ns Op / Ns Ar path
27 fb1a36c0 2022-01-09 op .Sh DESCRIPTION
34 14ae3944 2022-11-23 op names a remote file,
36 14ae3944 2022-11-23 op downloads it in the current directory and exit, otherwise changes the
37 14ae3944 2022-11-23 op remote working directory and starts accepting commands.
39 fb1a36c0 2022-01-09 op The options are as follows:
40 fb1a36c0 2022-01-09 op .Bl -tag -width Ds
44 fb1a36c0 2022-01-09 op .It Fl C Ar certificate
45 ab9f44f7 2022-11-23 op Connect with TLS to the remote server and use the given
46 fb1a36c0 2022-01-09 op .Ar certificate
47 ab9f44f7 2022-11-23 op during the TLS handsahke.
48 fb1a36c0 2022-01-09 op .It Fl K Ar key
49 fb1a36c0 2022-01-09 op Specify the path to the client certificate
51 fb1a36c0 2022-01-09 op to be used during the TLS handshake.
52 3b95ae81 2022-01-30 op If not given, the file passed to
57 ab9f44f7 2022-11-23 op must be provided too.
58 df9bb54d 2022-11-23 op .It Fl o Ar output
59 df9bb54d 2022-11-23 op When fetching the file specified to the command line,
60 df9bb54d 2022-11-23 op save its content in
62 df9bb54d 2022-11-23 op To write the content to standard output, use
64 df9bb54d 2022-11-23 op It's an error to specify
66 df9bb54d 2022-11-23 op when not givin a
70 df9bb54d 2022-11-23 op names a directory.
73 fb1a36c0 2022-01-09 op The following commands are recognized by
75 fb1a36c0 2022-01-09 op .Bl -tag -width Ds
76 fb1a36c0 2022-01-09 op .It Ic bell Oo Cm on | off Oc
77 fb1a36c0 2022-01-09 op Request terminal to sound a bell after each command.
78 fb1a36c0 2022-01-09 op Without arguments toggle the current state.
80 fb1a36c0 2022-01-09 op Terminate the session.
83 11cd7416 2022-01-16 op .It Ic cd Ar remote-path
84 11cd7416 2022-01-16 op Change the working directory on the remote machine to
85 11cd7416 2022-01-16 op .Ar remote-path .
86 11cd7416 2022-01-16 op .It Ic edit Ar remote-path
88 11cd7416 2022-01-16 op .Ar remote-path
89 11cd7416 2022-01-16 op and open it with the preferred editor
98 11cd7416 2022-01-16 op then attempt to re-upload it.
99 11cd7416 2022-01-16 op .It Ic get Ar remote-file Op Ar local-file
101 11cd7416 2022-01-16 op .Ar remote-file
102 11cd7416 2022-01-16 op and save it locally as
103 11cd7416 2022-01-16 op .Ar local-file .
105 11cd7416 2022-01-16 op .Ar local-file
106 11cd7416 2022-01-16 op is not given, use the file name from
107 11cd7416 2022-01-16 op .Ar remote-file .
108 5565d021 2022-01-16 op .It Ic hexdump Oo Cm on | off Oc
109 5565d021 2022-01-16 op Print the packets sent from/to the server.
110 5565d021 2022-01-16 op Without arguments, toggle the current state.
111 11cd7416 2022-01-16 op .It Ic lcd Op Ar local-directory
112 11cd7416 2022-01-16 op Change the local current working directory to
113 11cd7416 2022-01-16 op .Ar local-directory
116 11cd7416 2022-01-16 op if not given.
118 11cd7416 2022-01-16 op Print the local working directory.
120 11cd7416 2022-01-16 op List the file in the remote current working directory.
121 11cd7416 2022-01-16 op .It Ic page Ar remote-file
123 11cd7416 2022-01-16 op .Ar remote-file
124 11cd7416 2022-01-16 op and open it with the
126 11cd7416 2022-01-16 op .Pq Xr less 1 by default .
127 1c9ab7cf 2022-01-29 op .It Ic pipe Ar remote-file Ar cmd Op Ar args...
129 1c9ab7cf 2022-01-29 op .Ar remote-file
130 1c9ab7cf 2022-01-29 op and pass it as standard input for
132 1c9ab7cf 2022-01-29 op (with optional
133 1c9ab7cf 2022-01-29 op .Ar args Ns ).
134 11cd7416 2022-01-16 op .It Ic put Ar local-file Op Ar remote-file
136 11cd7416 2022-01-16 op .Ar local-file
138 11cd7416 2022-01-16 op .Ar remote-file .
140 11cd7416 2022-01-16 op .Ar remote-file
141 11cd7416 2022-01-16 op is not given,
142 11cd7416 2022-01-16 op use the file name from
143 11cd7416 2022-01-16 op .Ar local-file .
145 fb1a36c0 2022-01-09 op Terminate the session.
148 424338c2 2022-01-29 op .It Ic rename Ar remote-file Ar new-remote-name
150 13b8bb0a 2022-01-17 op .Ar remote-file
152 13b8bb0a 2022-01-17 op .Ar new-remote-name
153 13b8bb0a 2022-01-17 op on the remote server.
154 fb1a36c0 2022-01-09 op .It Ic verbose Oo Cm on | off Oc
155 fb1a36c0 2022-01-09 op Print verbose information.
156 fb1a36c0 2022-01-09 op Without arguments toggle the current state.
158 11cd7416 2022-01-16 op .Sh ENVIRONMENT
159 11cd7416 2022-01-16 op The following environment variables are inspected:
160 11cd7416 2022-01-16 op .Bl -tag -width Ds
162 11cd7416 2022-01-16 op The user login directory.
164 7d4a725d 2022-01-17 op The pager to use,
167 16012c8f 2022-10-07 op .It Ev VISUAL , Ev EDITOR
168 11cd7416 2022-01-16 op The program used to edit files.
170 11cd7416 2022-01-16 op is inspected first,
172 11cd7416 2022-01-16 op as a fallback.
173 11cd7416 2022-01-16 op If both are undefined,
175 11cd7416 2022-01-16 op is given some love.
177 6cd1a16b 2022-10-07 op Default login, used if no
179 6cd1a16b 2022-10-07 op is given on the command line.
187 fb1a36c0 2022-01-09 op utility was written by
188 fb1a36c0 2022-01-09 op .An Omar Polo Aq Mt op@omarpolo.com .