Debian Codegraph @

upstream/opensuse-tumbleweed/man1/cu.1

raw
1 '\"
2 .\" $Id: cu.1,v 1.10 2002/03/05 22:13:33 ian Rel $
3 .\"
4 .TH cu 1 "Taylor UUCP 1.07"
5 .SH NAME
6 cu \- Call up another system
7 .SH SYNOPSIS
8 .B cu
9 [ options ] [ system | phone | "dir" ]
10 .SH DESCRIPTION
11 The
12 .I cu
13 command is used to call up another system and act as a dial in
14 terminal. It can also do simple file transfers with no error
15 checking.
16
17 .I cu
18 takes a single argument, besides the options. If the argument is the
19 string "dir" cu will make a direct connection to the port. This may
20 only be used by users with write access to the port, as it permits
21 reprogramming the modem.
22
23 Otherwise, if the argument begins with a digit, it is taken to be a
24 phone number to call. Otherwise, it is taken to be the name of a
25 system to call. The
26 .B \-z
27 or
28 .B \-\-system
29 option may be used to name a system beginning with a digit, and the
30 .B \-c
31 or
32 .B \-\-phone
33 option may be used to name a phone number that does not begin with a
34 digit.
35
36 .I cu
37 locates a port to use in the UUCP configuration files. If a simple
38 system name is given, it will select a port appropriate for that
39 system. The
40 .B \-p, \-\-port, \-l, \-\-line, \-s
41 and
42 .B \-\-speed
43 options may be used to control the port selection.
44
45 When a connection is made to the remote system,
46 .I cu
47 forks into two processes. One reads from the port and writes to the
48 terminal, while the other reads from the terminal and writes to the
49 port.
50
51 .I cu
52 provides several commands that may be used during the conversation.
53 The commands all begin with an escape character, initially
54 .B ~
55 (tilde). The escape character is only recognized at the beginning of
56 a line. To send an escape character to the remote system at the start
57 of a line, it must be entered twice. All commands are either a single
58 character or a word beginning with
59 .B %
60 (percent sign).
61
62 .I cu
63 recognizes the following commands:
64
65 .TP 5
66 .B ~.
67 Terminate the conversation.
68 .TP 5
69 .B ~! command
70 Run command in a shell. If command is empty, starts up a shell.
71 .TP 5
72 .B ~$ command
73 Run command, sending the standard output to the remote system.
74 .TP 5
75 .B ~| command
76 Run command, taking the standard input from the remote system.
77 .TP 5
78 .B ~+ command
79 Run command, taking the standard input from the remote system and
80 sending the standard output to the remote system.
81 .TP 5
82 .B ~#, ~%break
83 Send a break signal, if possible.
84 .TP 5
85 .B ~c directory, ~%cd directory
86 Change the local directory.
87 .TP 5
88 .B ~> file
89 Send a file to the remote system. This just dumps the file over the
90 communication line. It is assumed that the remote system is expecting
91 it.
92 .TP 5
93 .B ~<
94 Receive a file from the remote system. This prompts for the local
95 file name and for the remote command to execute to begin the file
96 transfer. It continues accepting data until the contents of the
97 .B eofread
98 variable are seen.
99 .TP 5
100 .B ~p from to, ~%put from to
101 Send a file to a remote Unix system. This runs the appropriate
102 commands on the remote system.
103 .TP 5
104 .B ~t from to, ~%take from to
105 Retrieve a file from a remote Unix system. This runs the appropriate
106 commands on the remote system.
107 .TP 5
108 .B ~s variable value
109 Set a
110 .I cu
111 variable to the given value. If value is not given, the variable is
112 set to
113 .B true.
114 .TP 5
115 .B ~! variable
116 Set a
117 .I cu
118 variable to
119 .B false.
120 .TP 5
121 .B ~z
122 Suspend the cu session. This is only supported on some systems. On
123 systems for which ^Z may be used to suspend a job,
124 .B ~^Z
125 will also suspend the session.
126 .TP 5
127 .B ~%nostop
128 Turn off XON/XOFF handling.
129 .TP 5
130 .B ~%stop
131 Turn on XON/XOFF handling.
132 .TP 5
133 .B ~v
134 List all the variables and their values.
135 .TP 5
136 .B ~?
137 List all commands.
138
139 .I cu
140 also supports several variables. They may be listed with the
141 .B ~v
142 command, and set with the
143 .B ~s
144 or
145 .B ~!
146 commands.
147
148 .TP 5
149 .B escape
150 The escape character. Initially
151 .B ~
152 (tilde).
153 .TP 5
154 .B delay
155 If this variable is true,
156 .I cu
157 will delay for a second after recognizing the escape character before
158 printing the name of the local system. The default is true.
159 .TP 5
160 .B eol
161 The list of characters which are considered to finish a line. The
162 escape character is only recognized after one of these is seen. The
163 default is carriage return, ^U, ^C, ^O, ^D, ^S, ^Q, ^R.
164 .TP 5
165 .B binary
166 Whether to transfer binary data when sending a file. If this is
167 false, then newlines in the file being sent are converted to carriage
168 returns. The default is false.
169 .TP 5
170 .B binary-prefix
171 A string used before sending a binary character in a file transfer, if
172 the
173 .B binary
174 variable is true. The default is ^V.
175 .TP 5
176 .B echo-check
177 Whether to check file transfers by examining what the remote system
178 echoes back. This probably doesn't work very well. The default is
179 false.
180 .TP 5
181 .B echonl
182 The character to look for after sending each line in a file. The
183 default is carriage return.
184 .TP 5
185 .B timeout
186 The timeout to use, in seconds, when looking for a character, either
187 when doing echo checking or when looking for the
188 .B echonl
189 character. The default is 30.
190 .TP 5
191 .B kill
192 The character to use delete a line if the echo check fails. The
193 default is ^U.
194 .TP 5
195 .B resend
196 The number of times to resend a line if the echo check continues to
197 fail. The default is 10.
198 .TP 5
199 .B eofwrite
200 The string to write after sending a file with the
201 .B ~>
202 command. The default is ^D.
203 .TP 5
204 .B eofread
205 The string to look for when receiving a file with the
206 .B ~<
207 command. The default is $, which is intended to be a typical shell
208 prompt.
209 .TP 5
210 .B verbose
211 Whether to print accumulated information during a file transfer. The
212 default is true.
213 .SH OPTIONS
214 The following options may be given to
215 .I cu.
216 .TP 5
217 .B \-e, \-\-parity=even
218 Use even parity.
219 .TP 5
220 .B \-o, \-\-parity=odd
221 Use odd parity.
222 .TP 5
223 .B \-\-parity=none
224 Use no parity. No parity is also used if both
225 .B \-e
226 and
227 .B \-o
228 are given.
229 .TP 5
230 .B \-h, \-\-halfduplex
231 Echo characters locally (half-duplex mode).
232 .TP 5
233 .B \-\-nostop
234 Turn off XON/XOFF handling (it is on by default).
235 .TP 5
236 .B \-f, \-\-nortscts
237 Do not use hardware flow control.
238 .TP 5
239 .B \-E char, \-\-escape char
240 Set the escape character. Initially
241 .B ~
242 (tilde). To eliminate the escape character, use
243 .B -E ''.
244 .TP 5
245 .B \-z system, \-\-system system
246 The system to call.
247 .TP 5
248 .B \-c phone-number, \-\-phone phone-number
249 The phone number to call.
250 .TP 5
251 .B \-p port, \-\-port port
252 Name the port to use.
253 .TP 5
254 .B \-a port
255 Equivalent to
256 .B \-\-port port.
257 .TP 5
258 .B \-l line, \-\-line line
259 Name the line to use by giving a device name. This may be used to
260 dial out on ports that are not listed in the UUCP configuration files.
261 Write access to the device is required.
262 .TP 5
263 .B \-s speed, \-\-speed speed
264 The speed (baud rate) to use.
265 .TP 5
266 .B \-#
267 Where # is a number, equivalent to
268 .B \-\-speed #.
269 .TP 5
270 .B \-n, \-\-prompt
271 Prompt for the phone number to use.
272 .TP 5
273 .B \-d
274 Enter debugging mode. Equivalent to
275 .B \-\-debug all.
276 .TP 5
277 .B \-x type, \-\-debug type
278 Turn on particular debugging types. The following types are
279 recognized: abnormal, chat, handshake, uucp-proto, proto, port,
280 config, spooldir, execute, incoming, outgoing. Only abnormal, chat,
281 handshake, port, config, incoming and outgoing are meaningful for
282 .I cu.
283
284 Multiple types may be given, separated by commas, and the
285 .B \-\-debug
286 option may appear multiple times. A number may also be given, which
287 will turn on that many types from the foregoing list; for example,
288 .B \-\-debug 2
289 is equivalent to
290 .B \-\-debug abnormal,chat.
291 .B \-\-debug all
292 may be used to turn on all debugging options.
293 .TP 5
294 .B \-I file, \-\-config file
295 Set configuration file to use. This option may not be available,
296 depending upon how
297 .I cu
298 was compiled.
299 .TP 5
300 .B \-v, \-\-version
301 Report version information and exit.
302 .TP 5
303 .B \-\-help
304 Print a help message and exit.
305 .SH BUGS
306 This program does not work very well.
307 .SH AUTHOR
308 Ian Lance Taylor
309 <[email protected]>