1qodem-x11(1)                General Commands Manual               qodem-x11(1)
2
3
4

NAME

6       qodem-x11 - Qodem Terminal Emulator (X11 Version)
7
8

SYNOPSIS

10       qodem-x11 [ --capfile FILENAME ]
11             [ --logfile FILENAME ]
12             [ --keyfile FILENAME ]
13             [ --xl8file FILENAME ]
14             [ --xlufile FILENAME ]
15             [ --scrfile FILENAME ]
16             [ --config FILENAME ]
17             [ --create-config FILENAME ]
18             [ --dotqodem-dir DIRNAME ]
19             [ -x | --exit-on-completion ]
20             [ --doorway MODE ]
21             [ --codepage CODEPAGE ]
22             [ --emulation EMULATION ]
23             [ --status-line { on | off } ]
24             [ --play MUSIC ]
25             [ --play-exit ]
26             [ --read-only ]
27             [ --geometry COLSxROWS ]
28             [ [ --xterm ]                                    |
29             [ [ --dial n ]                                   |
30             [ [ --connect HOST [ --connect-method method ]
31               [ --username name ]                          ] |
32               args...                                      ]
33
34
35       qodem-x11 --version
36
37
38       qodem-x11 [ --help | -h | -? ]
39
40

DESCRIPTION

42       Qodem  is  an open-source clone implementation of the popular DOS-based
43       Qmodem serial communications program.  Qodem incorporates many features
44       that are useful on several kinds of text-based consoles such as scroll‐
45       back buffer, session capture, screen dump, dialing directory, and  also
46       includes serial port handling and modem dialing.
47
48       The major features of Qodem are:
49
50         * Unicode display: translation of CP437 (PC VGA), VT100 DEC Special
51           Graphics characters, VT220 National Replacement Character sets,
52           etc., to Unicode
53
54         * Terminal interface conveniences: scrollback buffer, capture file,
55           screen dump, dialing directory, keyboard macros, script support
56
57         * Connection methods: serial, local shell, command line, telnet,
58           ssh, rlogin, raw socket
59
60         * Emulations: ANSI, Avatar, VT52, VT100/102, VT220, Linux, XTerm,
61           PETSCII (Commodore), and ATASCII (Atari).
62
63         * Transfer protocols: Xmodem, Ymodem, Zmodem, and Kermit
64
65

OPTIONS

67       --capfile FILENAME
68              Capture the entire session and save to FILENAME.
69
70       --logfile FILENAME
71              Start the session log and log to FILENAME.
72
73       --keyfile FILENAME
74              Load keyboard macros from FILENAME.
75
76       --xl8file FILENAME
77              Load 8-bit translate tables from FILENAME.
78
79       --xlufile FILENAME
80              Load Unicode translate tables from FILENAME.
81
82       --scrfile FILENAME
83              Start script FILENAME after connect.
84
85       --config FILENAME
86              Load options from FILENAME (only).
87
88       --create-config FILENAME
89              Write a new options file to FILENAME and exit.
90
91       --dotqodem-dir DIRNAME
92              Use DIRNAME instead of $HOME/.qodem for config/data files.
93
94       --read-only
95              Disable  all  writes  to  disk.   No config files will be saved,
96              downloads are disabled, scripts are disabled,  no  screen  dump,
97              capture, logging, etc.
98
99       -x --exit-on-completion
100              Exit after connection/command finishes.
101
102       --doorway MODE
103              Select  doorway  MODE.   Valid  values  for  MODE are "doorway",
104              "mixed", and "off".
105
106       --codepage CODEPAGE
107              Select codepage CODEPAGE.  See Alt-; list for  valid  codepages.
108              Example: "CP437", "CP850", "Windows-1252", etc.
109
110       --emulation EMULATION
111              Select  emulation EMULATION.  Valid values are "ansi", "avatar",
112              "debug", "vt52", "vt100", "vt102", "vt220",  "linux",  "l_utf8",
113              "xterm", "x_utf8", "petscii", and "atascii".
114
115       --status-line { on | off }
116              If "on" enable status line.  If "off" disable status line.
117
118       --play MUSIC
119              Play  the  MUSIC  string as ANSI Music.  For more information on
120              ANSI Music, see http://www.textfiles.com/artscene/ansimusic/, or
121              the GWBASIC PLAY statement.
122
123       --play-exit
124              If --play was specified, exit immediately after playing MUSIC.
125
126       --geometry COLSxROWS
127              Request text window size COLS x ROWS.
128
129       --dial n
130              Immediately  open a connection to the phone book entry number n.
131              The first phone book entry has n=1.
132
133       --connect HOST
134              Immediately open a connection to HOST.  The  default  connection
135              method  is  "ssh"  unless  specified  with  the --connect-method
136              option.
137
138       --connect-method METHOD
139              Use METHOD to connect for the --connect  option.   Valid  values
140              are "ssh", "rlogin", "telnet", "socket", and "shell".
141
142       --username USERNAME
143              Use  USERNAME  when  connecting with the --connect option.  This
144              value is passed on the command line to ssh, and rlogin.
145
146       --xterm
147              Enables X11 terminal mode: phonebook and serial  port  are  dis‐
148              abled,  status  line is turned off at startup, doorway is set to
149              MIXED mode, a shell is opened, and Qodem exits  when  the  shell
150              session exits.
151
152       args...
153              Spawn a local shell and pass args to it.
154
155       --version
156              Display  program  version  and  brief  public  domain dedication
157              statement.
158
159       --help, -h, -?
160              Display usage screen.
161
162

CONNECTION METHODS

164       Qodem supports the following connection methods:
165
166
167       MODEM  Calls the remote system by dialing a phone number.
168
169       LOCAL  Spawns a local shell in a pseudo-tty.
170
171       RLOGIN Connects to the remote system using the rlogin protocol.   Qodem
172              can either spawn an executable to connect (e.g. 'rlogin') or use
173              its own networking code.  Its own networking code will only  run
174              successfully  if  Qodem  is  running as root, due to the need to
175              bind to a  privileged  port.   See  the  rlogin  and  use_exter‐
176              nal_rlogin options in qodemrc.
177
178       SSH    Connects to the remote system using the ssh protocol.  Qodem can
179              either spawn an executable to connect (e.g. 'ssh')  or  use  its
180              own  networking  code.  See the ssh and use_external_ssh options
181              in qodemrc.
182
183       TELNET Connects to the remote system using the telnet protocol.   Qodem
184              can either spawn an executable to connect (e.g. 'telnet') or use
185              its own networking code.  See the telnet and use_external_telnet
186              options in qodemrc.
187
188       SOCKET Connects to the remote system using a raw TCP socket.
189
190       CMDLINE
191              Spawns the command line in a pseudo-tty.
192
193

EMULATIONS

195       Emulations supported by Qodem and their status follows.  Note that TTY,
196       DEBUG, ANSI.SYS, AVATAR, LINUX, and XTERM  emulations  can  be  set  to
197       CP437  (DOS  VGA),  ISO-8859-1,  CP720 (DOS Arabic), CP737 (DOS Greek),
198       CP775 (DOS Baltic Rim), CP850 (DOS West European), CP852  (DOS  Central
199       European),  CP857  (DOS Turkish), CP858 (DOS West European+Euro), CP860
200       (DOS Portuguese), CP862 (DOS Hebrew), CP863 (DOS Quebecois), CP866 (DOS
201       Cyrillic),  Windows-1250  (Central/East European), Windows-1251 (Cyril‐
202       lic),  Windows-1252  (West  European),  KOI8-R  (Russian),  and  KOI8-U
203       (Ukrainian).
204
205       When  8-bit characters are used (see Alt-; Codepage below), the C0 con‐
206       trol characters (0x00 - 0x1F, 0x7F) are mapped to the equivalent  CP437
207       glyphs when there are no glyphs defined in that range for the set code‐
208       page.
209
210
211       ANSI   This is the DOS-based "ANSI.SYS" emulation plus a few more codes
212              than the original ANSI.SYS.  It supports DSR 6 (Cursor Position)
213              which many BBSes used to "autodetect" ANSI,  and  the  following
214              ANSI  X3.64 functions: ICH, DCH, IL, DL, VPA, CHA, CHT, and REP.
215              It also supports "ANSI Music" sequences that follow  the  "PLAY"
216              command syntax;  it plays these tones via SDL.
217
218       AVATAR This  is  the BBS-era Avatar ("Advanced Video Attribute Terminal
219              Assembler and Recreator") emulation.  It  supports  all  of  the
220              "Extended  AVT/0"  commands  as  per George A. Stanislav's 1 May
221              1989 document except for transmitting PC  keyboard  scan  codes.
222              It also includes ANSI fallback capability.
223
224       VT52   Fairly  complete.   Does not support HOLD SCREEN mode.  Graphics
225              mode glyphs that do not have direct Unicode  equivalents  render
226              as a hatch.
227
228       VT100  Identical   to  VT102  except  in  how  it  responds  to  Device
229              Attributes function.
230
231       VT102  Fairly complete.  Does not support smooth  scrolling,  printing,
232              keyboard locking, and hardware tests.  Many numeric keypad char‐
233              acters also do not work correctly due to console NUM  LOCK  han‐
234              dling.   132-column output is only supported if the host console
235              / window is already 132 columns or wider; Qodem does  not  issue
236              resize  commands to the host console for 80/132 column switching
237              codes.
238
239       VT220  Fairly complete.  Converts National Replacement  Character  sets
240              and  DEC  Supplemental Graphics characters to Unicode.  In addi‐
241              tion to limitations of VT102, also the  following  features  are
242              not  supported:  user-defined  keys (DECUDK), downloadable fonts
243              (DECDLD), VT100/ANSI compatibility mode (DECSCL).
244
245       TTY    This  emulation  supports  bare   control   character   handling
246              (backspace,  newline,  etc.)  and  litte  else.  Characters that
247              would be overwritten with underscores are  instead  made  under‐
248              lined as old teletypes would do.
249
250       DEBUG  This emulation displays all incoming characters in a format sim‐
251              ilar to a hex dump.
252
253       LINUX  This emulation has two modes: PC VGA (LINUX) and UTF-8 (L_UTF8).
254              This emulation is similar to VT102 but also recognizes the Linux
255              private mode sequences and ECMA-48 sequences VPA, CNL, CPL, ECH,
256              CHA,  VPA, VPR, and HPA.  In addition to VT102 limitations, also
257              the following features are not supported: selecting ISO  646/ISO
258              8859-1/UTF-8  character  sets,  X11 mouse reporting, and setting
259              the scroll/caps/numlock leds.
260
261       XTERM  This emulation has two modes: PC VGA (XTERM) and UTF-8 (X_UTF8).
262              It  recognizes  everything in LINUX, VT220, and a few more XTerm
263              sequences.  It does not support most of  the  advanced  features
264              unique  to  XTerm  such as Tektronix 4014 mode, alternate screen
265              buffer, and many more.  It is intended to support XTerm applica‐
266              tions that only use the sequences in the 'xterm' terminfo entry.
267
268       PETSCII
269              This very loosely emulates a 40-column Commodore 64/128.  Colors
270              are not quite right due to the IBM CGA colors  being  unable  to
271              match  the  Commodore  colors.   Uppercase/lowercase  affect new
272              characters  rather  than  the  whole  screen.   This   emulation
273              requires  the  C64  Pro  Mono  font  from  Style,  available  at
274              http://style64.org/c64-truetype/ .  (Note that this font is only
275              licensed  to  software packages that are "freely provided to end
276              users".  Entities wishing to ship packages that are not  "freely
277              provided  to end users" will need to either remove this font, or
278              negotiate a separate license agreement by  contacting  Style  at
279              http://style64.org/contact-style .)
280
281       ATASCII
282              This emulates the 8-bit Atari 400/800 series.
283
284

FILE TRANSFER PROTOCOLS

286       Protocols supported by Qodem and their status follows:
287
288       XMODEM Supports original Xmodem, Xmodem-1k, Xmodem-CRC16, and Xmodem-G.
289              Also supports "Xmodem Relaxed", a  variant  of  original  Xmodem
290              with longer timeouts.
291
292       YMODEM Supports  Ymodem  and  Ymodem-G.   If  a file exists, it will be
293              appended to.
294
295       ZMODEM Supports resume (crash recovery) and auto-start.  Does  not  yet
296              support changing block size on errors, so transfers over unreli‐
297              able serial/modem connections might  incur  significant  perfor‐
298              mance penalties.
299
300       KERMIT Supports the original robust (slow) Kermit plus streaming, slid‐
301              ing  windows,  and  autostart.   On  reliable  connections  with
302              streaming  it should perform reasonably well.  Does not yet sup‐
303              port long or extra-long packets, RESEND/REGET, or server mode.
304
305

INTERFACE

307       Phone Book
308       When Qodem first starts up, by default it will start in the phone book.
309       The  menu  on  the  bottom half of the screen lists the various actions
310       available.  When editing a phone  book  entry,  the  status  line  will
311       change to show options for each field.  Connecting to a system or leav‐
312       ing the phone book puts Qodem in Terminal Mode.
313
314       Terminal Mode
315       Terminal Mode is the main Qodem  terminal  emulator  interface.   Alt-Z
316       will  bring  up  a  help  menu.   While  in Terminal Mode the following
317       actions are supported:
318
319       Alt-D Phone Book
320              This brings up the phone book.
321
322       Alt-G Term Emulation
323              This brings up a menu to select the terminal emulation.  Select‐
324              ing  the active terminal emulation will prompt to reset the emu‐
325              lation state; this may  be  useful  to  recover  from  corrupted
326              escape sequences.
327
328       Alt-C Clear Screen
329              This clears the screen and homes the cursor.
330
331       Alt-F Execute Script
332              This  prompts  for  a filename, and then executes that file as a
333              script.  Any program that reads from standard input  and  writes
334              to  standard  output  can  be  run as a script.  See the section
335              below on script support.
336
337       Alt-K Send BREAK
338              When connected via serial mode  or  modem,  this  calls  tcsend‐
339              break() to send a true "Break Signal" on the serial line.
340
341       Alt-P Capture File
342              Enable/disable  capture  to file.  Four capture formats are sup‐
343              ported: "raw", "normal", "html", and "ask".  "Raw" format  saves
344              every byte as received from the other side before emulation pro‐
345              cessing; "normal" saves UTF-8 characters  after  emulation  pro‐
346              cessing;  "html"  saves in HTML format with Unicode entities and
347              color attributes after emulation processing; "ask" will bring up
348              a  dialog  to  select  which format to use every time capture is
349              enabled.  ASCII file transfers will be included in  the  capture
350              file;  other file transfers (Xmodem, Ymodem, Zmodem, Kermit) are
351              excluded from the capture file.
352
353       Alt-S Split Screen
354              This actives split screen mode, in which  local  characters  are
355              accumulated  in  a buffer before sending to the remote side.  To
356              send carriage return, enter "^M".
357
358       Alt-T Screen Dump
359              This prompts for a filename, and then saves the current view  to
360              that  file.   Three screen dump formats are supported: "normal",
361              "html", and "ask".  "normal" saves UTF-8 characters after emula‐
362              tion  processing; "html" saves in HTML format with Unicode enti‐
363              ties and color attributes after emulation processing; "ask" will
364              bring  up  a dialog to select which format to use every time the
365              screen is dumped.
366
367       Alt-Y COM Parameters
368              This brings up a menu to alter the serial port settings.
369
370       PgUp Upload Files
371              This brings up the file upload menu.  Note  that  CTRL-PgUp  and
372              ALT-PgUp  may  also  work depending on the terminfo for the host
373              terminal.
374
375       PgDn Download Files
376              This brings up the file download menu.  Note that CTRL-PgDn  and
377              ALT-PgDn  may  also  work depending on the terminfo for the host
378              terminal.
379
380       Alt-\ Alt Code Key
381              This brings up a dialog  to  enter  the  3-digit  decimal  value
382              (0-255)  for  an  8-bit  byte  or  a  4-digit  hexadecimal value
383              (0-ffff) for a  16-bit  Unicode  character  (L_UTF8  and  X_UTF8
384              only).
385
386       Alt-; Codepage
387              This  brings  up a dialog to change the current codepage.  Code‐
388              pages are limited by the current emulation.  VT52, VT100, VT102,
389              VT220, L_UTF8, X_UTF8, PETSCII, and ATASCII have their own code‐
390              page; LINUX, XTERM, ANSI, AVATAR, TTY, and DEBUG emulations  can
391              be  set  to:  CP437  (VGA),  ISO-8859-1,  CP720  (Arabic), CP737
392              (Greek), CP775 (Baltic Rim),  CP850  (Western  European),  CP852
393              (Central  European),  CP857  (Turkish),  CP858 (Western European
394              with euro), CP860 (Portuguese), CP862  (Hebrew),  CP863  (Quebec
395              French),  CP866  (Cyrillic),  CP1250 (Central/Eastern European),
396              CP1251  (Cyrillic),  CP1252  (Western  European),  KOI8_R  (Rus‐
397              sian),and KOI8_U (Ukrainian).
398
399       Alt-/ Scroll Back
400              This  selects  the  scrollback buffer.  When viewing the buffer,
401              "S" saves to file and "C"  clears  the  scrollback  buffer.   By
402              default Qodem supports up to 20000 lines of scrollback; this can
403              be changed by editing  scrollback_max  in  scrollback.c.   Three
404              scrollback  save  formats  are  supported: "normal", "html", and
405              "ask".  "normal" saves UTF-8 characters after emulation process‐
406              ing; "html" saves in HTML format with Unicode entities and color
407              attributes after emulation processing; "ask"  will  bring  up  a
408              dialog  to  select which format to use every time the scrollback
409              is saved.
410
411       Alt-H Hangup/Close
412              This hangs up the modem (drops DTR) or closes the remote connec‐
413              tion (kills the child process).
414
415       Alt-L Log View
416              This  brings  the  session log up in an editor.  The session log
417              stores  information  about   connect,   disconnect,   and   file
418              upload/download events.
419
420       Alt-M Mail Reader
421              This spawns the mail reader, by default mm.
422
423       Alt-X Exit Qodem
424              This  prompts  to  exit  Qodem.  When not connected, Ctrl-C will
425              also bring up the exit prompt.
426
427       Alt-A Translate Tables
428              This brings up the translate tables editor.  Both  incoming  and
429              outgoing  bytes  can  be  changed  or stripped (set to ASCII NUL
430              (0)).  Note that 8-bit INPUT translation occurs before both emu‐
431              lation processing and UTF-8 decoding.  Unicode INPUT translation
432              occurs before code points are written to the scrollback  buffer;
433              Unicode  OUTPUT  translation  occurs  after code points are read
434              from the keyboard.
435
436       Alt-J Function Keys
437              This brings up the keyboard macro editor.  Keyboard macros  sup‐
438              port  substitutions  for  control  characters including carriage
439              return ("^M"), the phone book entry username ("$USERNAME"),  and
440              the phone book entry password ("$PASSWORD").
441
442       Alt-N Configuration
443              This brings the qodemrc options file up in an editor.
444
445       Alt-: Colors
446              This brings the colors.cfg colors file up in an editor.
447
448       Alt-O Modem Config
449              This brings up the modem configuration dialog.
450
451       Alt-R OS Shell
452              This spawns a system shell.
453
454       Alt-V View File
455              This brings up a prompt to view a file in an editor.
456
457       Alt-W List Directory
458              This brings up a directory listing.
459
460       Alt-0 Session Log
461              This toggles the session log on or off.
462
463       Alt-1 XON/XOFF Flow Ctrl
464              When  connected  via modem or serial port, this toggles XON/XOFF
465              on or off.
466
467       Alt-2 Backspace/Del Mode
468              This selects whether the backspace key on the keyboard sends  an
469              ASCII backspace (^H) or an ASCII DEL (127) character.  Alt-\ 0 0
470              8 can always be used to send true backspace; Alt-\ 1 2 7 can  be
471              used  to  send true DEL.  Note that VT220 emulation always sends
472              DEL when the backspace key is pressed.
473
474       Alt-3 Line Wrap
475              This toggles line wrap mode on or off.  When line wrap  mode  is
476              enabled,  if  a  character is received when the cursor is at the
477              right margin it will wrap to the first column of the next line.
478
479       Alt-4 Display NULL
480              This selects whether ASCII  NUL  (0)  will  be  displayed  as  a
481              blank/space or stripped.
482
483       Alt-5 Host Mode
484              This switches Qodem into Host Mode.
485
486       Alt-6 Batch Entry Window
487              This  brings up the list of upload files used by Ymodem, Zmodem,
488              and Kermit uploads.
489
490       Alt-7 Status Line Info
491              This selects between two formats for the status line.
492
493       Alt-8 Hi-Bit Strip
494              This selects whether or not to clear the 8th bit of all incoming
495              bytes.   Note  that high-bit stripping occurs before both emula‐
496              tion processing and UTF-8 decoding.
497
498       Alt-9 Serial Port
499              This opens or closes the serial port.  If already connected to a
500              non-serial/modem remote host, this does nothing.
501
502       Alt-B Beeps & Bells
503              This  toggles  beep support on or off.  When beep support is on,
504              beeps from the remote host will be played by  Qodem.   In  LINUX
505              emulation,  Qodem  supports setting the tone and duration of the
506              beep as specified in console-codes(4).
507
508       Alt-E Half/Full Duplex
509              This toggles between half and full duplex.
510
511       Alt-I Qodem Information
512              This displays the Qodem splash screen which includes the version
513              and build date.
514
515       Alt-U Scrollback Record
516              This selects whether or not lines that scroll off the top of the
517              screen will be saved to the scrollback buffer.
518
519       Alt-= Doorway Mode
520              This selects between three doorway modes: "Doorway OFF",  "Door‐
521              way  MIXED"  and  "Doorway FULL".  When doorway mode is "Doorway
522              OFF", terminal mode responds to  all  of  its  command  keys  as
523              described in this section.  When doorway mode is "Doorway FULL",
524              all Alt- command keystrokes  except  Alt-=  are  passed  to  the
525              remote  side.   When  doorway  mode is "Doorway MIXED", terminal
526              mode supports a few commands but passes  the  majority  of  Alt-
527              command  keystrokes  to  the  remote side.  The default commands
528              supported in "Doorway MIXED" mode are:
529                   Alt-D Phone Book
530                   Alt-P Capture
531                   Alt-T Screen Dump
532                   Alt-Y COM Parameters
533                   Alt-Z Menu
534                   Alt-/ Scrollback
535                   Alt-PgUp or Ctrl-PgUp Upload Files
536                   Alt-PgDn or Ctrl-PgDn Download Files
537
538       Alt-- Status Lines
539              This toggles the status line on or off.
540
541       Alt-+ CR/CRLF Mode
542              This toggles whether or not received carriage returns imply line
543              feed or not.
544
545       Alt-, ANSI Music
546              This toggles ANSI music support on or off.
547
548

UNICODE SUPPORT

550       Qodem supports Unicode (UTF-8 encoding only) in the following functions
551       only: keyboard macros; phone book entries (NAME,  USERNAME,  and  PASS‐
552       WORD); modem device name.
553
554       UTF-8  is  NOT  supported  in  filenames,  modem  strings,  and  remote
555       addresses.
556
557

SCRIPT SUPPORT

559       Qodem does not have its own scripting language.  Instead,  any  program
560       that  reads and writes to the standard input and output can be run as a
561       Qodem script:
562
563           * Characters sent from the remote connection are visible to the
564             script in its standard input.
565
566           * Characters the script emits to its standard output are passed on
567             the remote connection.
568
569           * Messages to the standard error are reported to the user and also
570             recorded in the session log.
571
572       Since scripts are communicating with the remote system  and  not  Qodem
573       itself,  they  are  unable  to script Qodem's behavior, e.g. change the
574       terminal emulation, hangup and dial another phone book entry,  download
575       a  file,  etc.   However, they can be written in any language, and they
576       can be tested outside Qodem.
577
578       Scripts replace the user, and as such have similar constraints:
579
580         * Script standard input, output, and  error  must  all  be  in  UTF-8
581       encoding.
582
583         * Scripts should send carriage return (0x0D, or \r) instead of new
584           line (0x0A, or \n) to the remote side - the same as if a user
585           pressed the Enter key.  They should expect to see either bare
586           carriage return (0x0D, or \r) or carriage return followed by
587           newline (0x0D 0x0A, or \r\n) from the remote side.
588
589         *  Input  and  output translate byte translation (the Alt-A Translate
590       Tables) are honored for scripts.
591
592         * While a script is running:
593               - Zmodem and Kermit autostart are disabled.
594               - Keyboard function key macros are disabled.
595               - Qodem functions accessed through the Alt-character
596                 combinations and PgUp/PgDn are unavailable.
597               - Pressing Alt-P will pause the script.
598
599         * While a script is paused:
600               - The script will receive nothing on its standard input.
601               - Anything in the script's standard output will be held until
602                 the script is resumed.
603               - The script process will not be signaled; it may continue
604                 running in its own process.
605               - The only Alt-character function recognized is AltP to
606                 resume the script.  All other Alt- keys will be ignored.
607               - Keys pressed will be sent directly to the remote system.
608               - Keyboard function key macros will work.
609
610       Scripts are launched in two ways:
611
612         * In TERMINAL mode, press Alt-F and enter the script filename.  The
613           script will start immediately.
614
615         * In the phone book, add a script filename to a phone book entry.
616           The script will start once that entry is connected.
617
618       Script command-line arguments can be passed directly in both the  Alt-F
619       script  dialog  and  the  phone book linked script field.  For example,
620       pressing  Alt-F  and   entering   "my_script.pl   arg1"   will   launch
621       my_script.pl  and  with  its  first  command-line argument ($ARGV[0] in
622       Perl) set to "arg1".
623
624

ENVIRONMENT VARIABLES

626       Qodem makes use of the following variables:
627
628       HOME   The user's  home  directory.   Qodem  creates  two  directories:
629              $HOME/.qodem  for  qodem's  internal files (phone book, keyboard
630              macro  files,  translate  tables,  etc.)  and  $HOME/qodem   for
631              uploaded and downloaded files, session log, capture, etc.
632
633       EDITOR If  present,  this  will  be used when spawning external editors
634              (log view, edit configuration, view file, edit phone book note).
635              If  not  present,  by default (editable in the options file) use
636              vi.
637
638       ESCDELAY
639              This is a timeout value in  milliseconds  used  by  the  ncurses
640              get_wch()  and  wget_wch()  functions  to  determine  if  a user
641              pressed bare  ESCAPE.   On  some  systems  pressing  ESCAPE  may
642              require  up  to  a full second before Qodem can process it.  For
643              Qodem backtick (`) can be used instead of ESCAPE.
644
645

FILES

647       $HOME/.qodem/qodemrc
648              Qodem options/configuration file.  Inline comments describe  the
649              options.
650
651

SEE ALSO

653       qodem(1),   xqodem(1),   mm(1),   kermit(1),   gkermit(1),  minicom(1),
654       rlogin(1), ssh(1), telnet(1), xterm(1), vttest(1), console-codes(4)
655
656

BUGS

658       The screensaver might not load under all circumstances even  after  the
659       timeout has passed.
660
661

HOMEPAGE

663       The  Qodem  homepage  is  at  <http://qodem.sourceforge.net>.  The code
664       repository is hosted at <https://github.com/klamonte/qodem>.
665
666

PUBLIC DOMAIN NOTICE

668       Written 2003-2017 by Kevin Lamonte
669
670       To the extent possible under law,  the  author(s)  have  dedicated  all
671       copyright  and  related  and neighboring rights to this software to the
672       public domain worldwide. This software is distributed without any  war‐
673       ranty.
674
675
676
677                                 June 18, 2017                    qodem-x11(1)
Impressum