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