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