Import jupp25
[alioth/jupp.git] / HINTS
1 This documentation should go elsewhere, but I haven't gotten around to it
2 yet.
3
4 GCC
5 ---
6
7 Using -fomit-frame-pointer may miscompile code at least in gcc 3.4.6, see
8 http://article.gmane.org/gmane.os.miros.cvs/11607 for details.
9
10 Disable the following warnings; the code doesn't cope with it:
11 -Wno-pointer-sign
12 -Wno-unused-parameter
13 -Wno-missing-field-initializers
14 -Wno-old-style-definition -Wno-strict-prototypes
15 -Wno-cast-qual
16 -Wno-missing-prototypes -Wno-missing-declarations
17
18 Additionally, -Wstrict-overflow bitches around if you enable it.
19 This needs verification and possibly fixes.
20
21 UTF-8
22 -----
23
24 JOE now handles two classes of character sets: UTF-8 and byte coded (like
25 ISO-8859-1).  It can not yet handle other major classes such as UTF-16 or
26 GB2312. There are other restrictions: character sets must use LF (0x0A) or
27 CR-LF (0x0D - 0x0A) as line terminators, space must be 0x20 and tab must be
28 0x09. Basically, the files must be UNIX or MS-DOS compatible text files.
29
30 This means EBCDIC will not work properly (but you would need to handle fixed
31 record length lines anyway) and character sets which use CR terminated lines
32 (MACs) will not yet work.
33
34 The terminal and the file can have different encodings.  JOE will translate
35 between the two.  Currently, one of the two must be UTF-8 for translation to
36 work.
37
38 The character set for the terminal and the default character set assumed for
39 files is determined by the 'LC_ALL' environment variable (and if that's not
40 set, LC_CTYPE and LANG are also checked).
41
42 For example, if LC_ALL is set to:
43
44         de_DE
45
46 Then the character set will be ISO-8859-1.
47
48 If LC_ALL is set to:
49
50         de_DE.UTF-8
51
52 The character set will UTF-8.
53
54 Hit ^T E to change the coding for the file.  Hit <tab> <tab> at this prompt
55 to get a list of available codings.  There are a number of built-in
56 character sets, plus you can install character sets in the ~/.joe/charmaps
57 and /usr/local/etc/joe/charmaps directories.
58
59 Check: /usr/share/i18n/charmaps for example character set files.  Only
60 byte oriented character sets will work.  Also, the file should not be
61 gzipped (all of the charmap file in /usr/share/i18n/charmaps on my computer
62 were compressed).  The parser is very bad, so basically the file has to look
63 exactly like the example one in /usr/local/etc/joe/charmaps.
64
65 You can hit ^K <space> to see the current character set.
66
67 You can hit ` x to enter a Unicode character if the file coding is UTF-8.
68
69 Programming
70 -----------
71
72         Try ^K , and ^K .  These keys select the current block (based on
73 indentation) and shift it left or right by the -istep and -indentc.
74
75 Selecting blocks
76 ----------------
77
78         The "classic" way is to hit ^K B at the beginning and ^K K at the
79 end.  These set pointers called markb and markk.  Once these are set you
80 can jump to markb with ^[ b and jump to markk with ^[ k.
81
82         New way no.1: hit Ctrl-space to start selecting, move the cursor,
83 then hit Ctrl-space to complete the block.  Hit Ctrl-space in the block to
84 cancel it.  Hit Ctrl-space outside of the block to start selecting a new
85 one.  This uses the "toggle_marking" function.  Also any block command will
86 complete the block. (joe flavour only)
87
88         New way no.2: hit Ctrl-rtarw to start selecting rightward.  Each
89 time you hit Ctrl-rtarw, the block is extended one more to the right.  This
90 uses a simple macro: "begin_marking,rtarw,toggle_marking".  Unfortunately,
91 there is no standard way to get the keysequence given by the terminal
92 emulator when you hit Ctrl-rtarw.  Instead you have to determine this
93 sequence yourself and enter it directly in the joerc file.  Some examples
94 are given for xterm and gnome-terminal.  Hit ` rtarw to have the sequence
95 shown on your screen.  Note that Putty uses ^[ ^[ [ C which will not appear
96 with ` rtarw (also ^[ ^[ is set book mark, so you need to unbind it to do
97 this in Putty). (joe flavour only)
98
99         Also you can hit Ctrl-delete to cut and Ctrl-insert to paste if the
100 sequence for these keys are known. (joe flavour only)
101
102         New way No.3: press down shift, then move the cursor with the
103 arrow keys or, optionally with ctrl, the Home and End keys; release the
104 shift key when done and remember that the cursor indicator on screen is
105 not part of the selection. (all flavours)
106
107         Also, you can pass "-keymap cua" on the command line to change
108 the key bindings for ^Z (Undo), ^X (Cut), ^C (Copy), ^V (Paste) as in
109 contemporary GUI editors. (joe, rjoe, jstar, jupp flavours only)
110
111         Using Picture mode and Rectangle mode may help with that.
112
113 Hex edit mode
114 -------------
115
116 When this mode is selected (either put -hex on the command line, or look for
117 "Hex edit mode" after hitting ^T), the buffer is displayed as a hex dump,
118 but all of the editing commands operate the same way.  It is most useful to
119 select overtype mode in conjunction with hex dump (hit ^T T).  Then typing
120 will not insert.
121
122 - To enter the hex byte 0xF8 type ` x F 8
123
124 - You can use ^KC to copy a block as usual.  If overtype mode is selected,
125   the block will overwrite the destination data without changing the size of
126   the file.  Otherwise it inserts. 
127
128 - Hit ESC x byte <Enter>, to jump to a particular byte offset.  Hex values
129   can be entered into this prompt like this: 0x2000.
130
131 - Search, incremental search, and search & replace all operate as usual.
132
133 __________________________________________________________________
134 $MirOS: contrib/code/jupp/HINTS,v 1.7 2013/08/19 22:04:14 tg Exp $