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