Commit | Line | Data |
3e03d89e |
1 | .TH SSFE 1 "" "Roger Espel Llima" |
2 | .SH NAME |
3 | ssfe \- split-screen front-end |
4 | .SH SYNOPSIS |
5 | .B ssfe |
6 | [options] program-name [program-options] |
7 | .SH DESCRIPTION |
8 | .B ssfe |
9 | runs a line-oriented program in the background, and provides a full |
10 | screen interface for it. The bottom line of the screen is the input |
11 | line, which you can edit using emacs-like keys; above that is the |
12 | status bar, and the scrolling area with the program's output. |
13 | .PP |
14 | You can configure |
15 | .B ssfe |
16 | to reprint or not your own input lines, to use prompts, and to do word-wrap |
17 | on the program's output. |
18 | .PP |
19 | .B ssfe |
20 | also understands a little protocol to communicate with the program it is |
21 | running, which can be used to change the contents of the status line, |
22 | to set ssfe's modes and to prompt for input. |
23 | .SH OPTIONS |
24 | .TP |
25 | .BR "-raw" |
26 | Disables word-wrap and handling of control characters. In this mode, ssfe |
27 | will not attempt keep track of the cursor's position. |
28 | .TP |
29 | .BR "-cooked" |
30 | Enables word-wrap, and prints control characters using inverse-video; this |
31 | is the default mode. |
32 | .TP |
33 | .BR "-irc" |
34 | Same as -cooked, but also interprets Ctrl-B, Ctrl-V and Ctrl-_ with the |
35 | IRC convention (toggles for bold, inverse, underlined, respectively). |
36 | .TP |
37 | .BR "-hold" |
38 | Sets hold-mode. In hold mode, |
39 | .B ssfe |
40 | will stop after each screenful, and wait for the user to hit TAB. |
41 | .TP |
42 | .BR "-beep" |
43 | In cooked or IRC mode, enables beeps. When beeps are disabled, the |
44 | character Ctrl-G is displayed as an inverse-video G. |
45 | .TP |
46 | .BR "-flow" |
47 | Enables flow-control with ^S and ^Q. |
48 | .B ssfe |
49 | normally disables those, but some terminals require them to operate properly. |
50 | .TP |
51 | .BR "-print" |
52 | Enables printing of your own commands back in the scrolling area. |
53 | .TP |
54 | .BR "-prompt \fI<prompt>\fR" |
55 | Sets a prompt for the user input line. The default prompt is none, or |
56 | ``> '' if -print is specified. |
57 | |
58 | .SH ARGUMENTS |
59 | .TP |
60 | .BR "program [options]" |
61 | Names the program that |
62 | .B ssfe |
63 | should run. |
64 | |
65 | .SH KEYS |
66 | .B ssfe |
67 | understands these keys (^ means Control): |
68 | .TP |
69 | .BR "^\e" |
70 | Interrupt ssfe and whatever program it's running, and exit back to the unix |
71 | prompt. |
72 | .TP |
73 | .BR "^a" |
74 | Go to the beginning of the line. |
75 | .TP |
76 | .BR "^b, left arrow" |
77 | Move left a letter. |
78 | .TP |
79 | .BR "^c" |
80 | Interrupt: ignored by the front-end, can be used to interrupt connecting to a |
81 | server, with sirc. |
82 | .TP |
83 | .BR "^d" |
84 | Delete the character under the cursor. |
85 | .TP |
86 | .BR "^e" |
87 | Go to the end of the line. |
88 | .TP |
89 | .BR "^f, right arrow" |
90 | Move right a letter. |
91 | .TP |
92 | .BR "^h, DEL" |
93 | Erase the previous character. |
94 | .TP |
95 | .BR "^i, TAB" |
96 | Go to next /msg in msg history. |
97 | .TP |
98 | .BR "^j, ^m, Enter" |
99 | .TP |
100 | .BR "^k" |
101 | Erase from the cursor to the end of the line. |
102 | .TP |
103 | .BR "^l" |
104 | Redisplay the status bar and the command line. |
105 | .TP |
106 | .BR "^n, down arrow" |
107 | Go to the next line in command-line history. |
108 | .TP |
109 | .BR "^o" |
110 | With sirc, type the last msg you got on the command line |
111 | .TP |
112 | .BR "^p, up arrow" |
113 | Go to the previous line in command-line history. |
114 | .TP |
115 | .BR "^t" |
116 | With sirc, switch to the next channel you're on. |
117 | .TP |
118 | .BR "^u" |
119 | Erase command-line. |
120 | .TP |
121 | .BR "^v" |
122 | Insert the next character literally, even if it's a ^something. |
123 | .TP |
124 | .BR "^x b" |
125 | Toggle beep on or off (off by default). |
126 | .TP |
127 | .BR "^x c" |
128 | Exit the front end, back to the unix prompt. |
129 | .TP |
130 | .BR "^x h" |
131 | Toggle hold mode. |
132 | .TP |
133 | .BR "^x i" |
134 | Toggle irc-mode (^b^v^_ handling) on and off. |
135 | .TP |
136 | .BR "^y" |
137 | Yank the current line in the history without sending it. |
138 | .TP |
139 | .BR "^z" |
140 | Suspend ssfe and sirc and go back to the unix prompt - you come back with 'fg'. |
141 | |
142 | .SH COPYING |
143 | .B ssfe |
144 | is free software. You can redistribute it and/or modify it under the GNU |
145 | General Public License as published by the Free Software Foundation. See |
146 | the file LICENSE for details. |
147 | |
148 | .SH SEE ALSO |
149 | .BR sirc (1) |
150 | |
151 | .SH ENVIRONMENT VARIABLES |
152 | .TP |
153 | .BR TERM |
154 | sets the terminal type. The terminal needs to be able to set a scrolling |
155 | zone for ssfe to work. |
156 | |
157 | .SH BUGS |
158 | None known, please report to the author. |
159 | |
160 | .SH AUTHOR |
161 | .B sirc |
162 | was written by Roger Espel Llima <roger.espel.llima@pobox.com>. |
163 | |