comparison runtime/doc/os_risc.txt @ 1668:0b796e045c42 v7.2b.000

updated for version 7.2b-000
author vimboss
date Sun, 13 Jul 2008 17:41:49 +0000
parents 73fe8baea242
children f4f8014d516e
comparison
equal deleted inserted replaced
1667:131dbd3d2a4b 1668:0b796e045c42
1 *os_risc.txt* For Vim version 7.2a. Last change: 2005 Mar 29 1 *os_risc.txt* For Vim version 7.2b. Last change: 2008 Jun 28
2 2
3 3
4 VIM REFERENCE MANUAL by Thomas Leonard 4 VIM REFERENCE MANUAL by Thomas Leonard
5 5
6 6
7 *riscos* *RISCOS* *RISC-OS* 7 *riscos* *RISCOS* *RISC-OS*
8 This file contains the particularities for the RISC OS version of Vim. 8 This file contains the particularities for the RISC OS version of Vim.
9 9
10 The RISC OS port is a completely new port and is not based on the old `archi' 10 The RISC OS port is a completely new port and is not based on the old "archi"
11 port. 11 port.
12 12
13 1. File locations |riscos-locations| 13 1. File locations |riscos-locations|
14 2. Filename munging |riscos-munging| 14 2. Filename munging |riscos-munging|
15 3. Command-line use |riscos-commandline| 15 3. Command-line use |riscos-commandline|
44 44
45 !Vim.Resources and !Vim.Resources2 contain the files from the standard Vim 45 !Vim.Resources and !Vim.Resources2 contain the files from the standard Vim
46 distribution, but modified slightly to work within the limits of ADFS, plus 46 distribution, but modified slightly to work within the limits of ADFS, plus
47 some extra files such as the window templates. 47 some extra files such as the window templates.
48 48
49 User choices are read from `Choices:*' and are saved to `<Choices$Write>.*'. 49 User choices are read from "Choices:*" and are saved to "<Choices$Write>.*".
50 If you have the new !Boot structure then these should be set up already. If 50 If you have the new !Boot structure then these should be set up already. If
51 not, set Choices$Path to a list of directories to search when looking for 51 not, set Choices$Path to a list of directories to search when looking for
52 user configuration files. Set Choices$Write to the directory you want files 52 user configuration files. Set Choices$Write to the directory you want files
53 to be saved into (so your search patterns and marks can be remembered between 53 to be saved into (so your search patterns and marks can be remembered between
54 sessions). 54 sessions).
56 ============================================================================== 56 ==============================================================================
57 *riscos-munging* 57 *riscos-munging*
58 2. Filename munging 58 2. Filename munging
59 59
60 All pathname munging is disabled by default, so Vim should behave like a 60 All pathname munging is disabled by default, so Vim should behave like a
61 normal RISC OS application now. So, if you want to edit `doc/html' then you 61 normal RISC OS application now. So, if you want to edit "doc/html" then you
62 actually type `*vi doc/html'. 62 actually type "*vi doc/html".
63 63
64 The only times munging is done is when: 64 The only times munging is done is when:
65 65
66 - Searching included files from C programs, since these are always munged. 66 - Searching included files from C programs, since these are always munged.
67 See |[I|. 67 See |[I|.
68 Note: make sure you are in the right directory when you use this 68 Note: make sure you are in the right directory when you use this
69 command (i.e. the one with subdirectories 'c' and 'h'). 69 command (i.e. the one with subdirectories "c" and "h").
70 70
71 - Sourcing files using |:so|. 71 - Sourcing files using |:so|.
72 Paths starting `$VIM/' are munged like this: 72 Paths starting "$VIM/" are munged like this:
73 73
74 $VIM/syntax/help.vim -> Vim:syntax.help 74 $VIM/syntax/help.vim -> Vim:syntax.help
75 75
76 Also, files ending in `.vim' have their extensions removed, and slashes 76 Also, files ending in ".vim" have their extensions removed, and slashes
77 replaced with dots. 77 replaced with dots.
78 78
79 Some tag files and script files may have to be edited to work under this port. 79 Some tag files and script files may have to be edited to work under this port.
80 80
81 ============================================================================== 81 ==============================================================================
82 *riscos-commandline* 82 *riscos-commandline*
83 3. Command-line use 83 3. Command-line use
84 84
85 To use Vim from the command-line use the `*vi' command (or '*ex' for 85 To use Vim from the command-line use the "*vi" command (or "*ex" for
86 |Ex-mode|). 86 |Ex-mode|).
87 87
88 Type `*vi -h' for a list of options. 88 Type "*vi -h" for a list of options.
89 89
90 Running the command-line version of Vim in a large high-color mode may cause 90 Running the command-line version of Vim in a large high-color mode may cause
91 the scrolling to be very slow. Either change to a mode with fewer colors or 91 the scrolling to be very slow. Either change to a mode with fewer colors or
92 use the GUI version. 92 use the GUI version.
93 93
147 If only one of width and height is given then that 147 If only one of width and height is given then that
148 value is used for both. If neither is given then 10 148 value is used for both. If neither is given then 10
149 point is used. 149 point is used.
150 150
151 Thanks to John Kortink, Vim can use the ZapRedraw module. Start the font name 151 Thanks to John Kortink, Vim can use the ZapRedraw module. Start the font name
152 with '!' (or '!!' for double height), like this: > 152 with "!" (or "!!" for double height), like this: >
153 153
154 :set guifont=!! 154 :set guifont=!!
155 < Use the system font, but via ZapRedraw. This gives a 155 < Use the system font, but via ZapRedraw. This gives a
156 faster redraw on StrongARM processors, but you can't 156 faster redraw on StrongARM processors, but you can't
157 get bold or italic text. Double height. 157 get bold or italic text. Double height.
158 > 158 >
159 :set guifont=!script 159 :set guifont=!script
160 < Uses the named Zap font (a directory in VimFont$Path). 160 < Uses the named Zap font (a directory in VimFont$Path).
161 The redraw is the same speed as for '!!', but you get 161 The redraw is the same speed as for "!!", but you get
162 a nicer looking font. 162 a nicer looking font.
163 Only the "man+" and "script" fonts are supplied 163 Only the "man+" and "script" fonts are supplied
164 currently, but you can use any of the Zap fonts if 164 currently, but you can use any of the Zap fonts if
165 they are in VimFont$Path. 165 they are in VimFont$Path.
166 Vim will try to load font files '0', 'B', 'I' and 'IB' 166 Vim will try to load font files "0", "B", "I" and "IB"
167 from the named directory. Only '0' (normal style) MUST 167 from the named directory. Only "0" (normal style) MUST
168 be present. Link files are not currently supported. 168 be present. Link files are not currently supported.
169 169
170 Note that when using ZapRedraw the edit bar is drawn in front of the character 170 Note that when using ZapRedraw the edit bar is drawn in front of the character
171 you are on rather than behind it. Also redraw is incorrect for screen modes 171 you are on rather than behind it. Also redraw is incorrect for screen modes
172 with eigen values of 0. If the font includes control characters then you can 172 with eigen values of 0. If the font includes control characters then you can
189 allow other codes to be used if you want to use Vim from a remote terminal. 189 allow other codes to be used if you want to use Vim from a remote terminal.
190 190
191 Although I do not have an internet connection to my Acorn, I have managed to 191 Although I do not have an internet connection to my Acorn, I have managed to
192 run Vim in a FreeTerm window using the loopback connection. 192 run Vim in a FreeTerm window using the loopback connection.
193 193
194 It seems to work pretty well now, using '*vi -T ansi'. 194 It seems to work pretty well now, using "*vi -T ansi".
195 195
196 ============================================================================== 196 ==============================================================================
197 *riscos-temp-files* 197 *riscos-temp-files*
198 6. Temporary files 198 6. Temporary files
199 199
201 directories set with the 'directory' and 'bdir' options. By default the swap 201 directories set with the 'directory' and 'bdir' options. By default the swap
202 files are in <Wimp$ScrapDir> (i.e. inside !Scrap) and backups are in the 202 files are in <Wimp$ScrapDir> (i.e. inside !Scrap) and backups are in the
203 directory you were saving to. Vim will allow you to try and recover the file 203 directory you were saving to. Vim will allow you to try and recover the file
204 when you next try to edit it. 204 when you next try to edit it.
205 205
206 To see a list of swap files, press <F12> and type `*vi -r'. 206 To see a list of swap files, press <F12> and type "*vi -r".
207 207
208 Vim no longer brings up ATTENTION warnings if you try to edit two files with 208 Vim no longer brings up ATTENTION warnings if you try to edit two files with
209 the same name in different directories. 209 the same name in different directories.
210 210
211 However, it also no longer warns if you try to edit the same file twice (with 211 However, it also no longer warns if you try to edit the same file twice (with
226 Vim will use dynamic areas on RISC OS 3.5 or later. If you can use them on 226 Vim will use dynamic areas on RISC OS 3.5 or later. If you can use them on
227 older machines then edit the !RunTxt and GVim files. I don't know what UnixLib 227 older machines then edit the !RunTxt and GVim files. I don't know what UnixLib
228 does by default on these machines so I'm playing safe. 228 does by default on these machines so I'm playing safe.
229 229
230 It doesn't work at all well without dynamic areas, since it can't change its 230 It doesn't work at all well without dynamic areas, since it can't change its
231 memory allocation once running. Hence you should edit `!Vim.GVim' and 231 memory allocation once running. Hence you should edit "!Vim.GVim" and
232 `!Vim.!RunTxt' to choose the best size for you. You probably need at least 232 "!Vim.!RunTxt" to choose the best size for you. You probably need at least
233 about 1400K. 233 about 1400K.
234 234
235 ============================================================================== 235 ==============================================================================
236 *riscos-filetypes* 236 *riscos-filetypes*
237 9. Filetypes 237 9. Filetypes
250 - Saving the file will give it a filetype of |'osfiletype'|. 250 - Saving the file will give it a filetype of |'osfiletype'|.
251 251
252 Some examples may make this clearer: 252 Some examples may make this clearer:
253 253
254 Kind of file loaded osfiletype filetype ~ 254 Kind of file loaded osfiletype filetype ~
255 C code 'c.hellow' Text (&fff) C 255 C code "c.hellow" Text (&fff) C
256 LaTeX document LaTeX (&2a8) TeX 256 LaTeX document LaTeX (&2a8) TeX
257 Draw document DrawFile (&aff) (not changed) 257 Draw document DrawFile (&aff) (not changed)
258 258
259 ============================================================================== 259 ==============================================================================
260 *riscos-shell* 260 *riscos-shell*
261 10. The shell 261 10. The shell
262 262
263 - Bangs (!s) are only replaced if they are followed by a space or end-of-line, 263 - Bangs (!s) are only replaced if they are followed by a space or end-of-line,
264 since many pathnames contain them. 264 since many pathnames contain them.
265 265
266 - You can prefix the command with '~', which stops any output from being 266 - You can prefix the command with "~", which stops any output from being
267 displayed. This also means that you don't have to press <Enter> afterwards, 267 displayed. This also means that you don't have to press <Enter> afterwards,
268 and stops the screen from being redrawn. {only in the GUI version} 268 and stops the screen from being redrawn. {only in the GUI version}
269 269
270 ============================================================================== 270 ==============================================================================
271 *riscos-porting* 271 *riscos-porting*
273 273
274 Downloading everything you need: 274 Downloading everything you need:
275 275
276 - Get the latest source distribution (see www.vim.org) 276 - Get the latest source distribution (see www.vim.org)
277 - Get the runtime environment files (e.g. these help files) 277 - Get the runtime environment files (e.g. these help files)
278 - Get the `extra' archive (contains the RISC OS specific bits) 278 - Get the "extra" archive (contains the RISC OS specific bits)
279 - Get the RISC OS binary distribution (if possible) 279 - Get the RISC OS binary distribution (if possible)
280 280
281 281
282 Unarchiving: 282 Unarchiving:
283 283
287 287
288 288
289 Recompiling the sources: 289 Recompiling the sources:
290 290
291 - Create c, s, and h directories. 291 - Create c, s, and h directories.
292 - Put all the header files in 'h'. \ 292 - Put all the header files in "h". \
293 - Put all the C files in `c'. | And lose the extensions 293 - Put all the C files in "c". | And lose the extensions
294 - Put the assembler file (`swis/s') in 's'. / 294 - Put the assembler file ("swis/s") in "s". /
295 - Rename all the files in `proto' to `h', like this: 295 - Rename all the files in "proto" to "h", like this:
296 raFS::VimSrc.source.proto.file/pro 296 raFS::VimSrc.source.proto.file/pro
297 becomes 297 becomes
298 raFS::VimSrc.source.h.file_pro 298 raFS::VimSrc.source.h.file_pro
299 - In the files `h.proto' and `c.termlib', search and replace 299 - In the files "h.proto" and "c.termlib", search and replace
300 .pro" 300 .pro"
301 with 301 with
302 _pro.h" 302 _pro.h"
303 - Create a simple Makefile if desired and do '*make -k'. 303 - Create a simple Makefile if desired and do "*make -k".
304 Use 'CC = gcc -DRISCOS -DUSE_GUI -O2 -x c' in the Makefile. 304 Use "CC = gcc -DRISCOS -DUSE_GUI -O2 -x c" in the Makefile.
305 - Save the binary as !Vim.Vim in the binary distribution. 305 - Save the binary as !Vim.Vim in the binary distribution.
306 306
307 307
308 Updating the run-time environment: 308 Updating the run-time environment:
309 309
310 - Replace old or missing files inside !Vim.Resources with the 310 - Replace old or missing files inside !Vim.Resources with the
311 new files. 311 new files.
312 - Remove files in `doc' not ending in `/txt', except for `tags'. 312 - Remove files in "doc" not ending in "/txt", except for "tags".
313 - Lose the extensions from the files in `doc'. 313 - Lose the extensions from the files in "doc".
314 - Edit the `doc.tags' file. Remove extensions from the second column: > 314 - Edit the "doc.tags" file. Remove extensions from the second column: >
315 :%s/^\(.[^\t]*\t.*\)\.txt\t/\1\t/ 315 :%s/^\(.[^\t]*\t.*\)\.txt\t/\1\t/
316 - Remove extensions from the syntax files. Split them into two directories 316 - Remove extensions from the syntax files. Split them into two directories
317 to avoid the 77 entry limit on old ADFS filesystems. 317 to avoid the 77 entry limit on old ADFS filesystems.
318 - Edit `Vim:FileType' to match `*.c.*' as well as `*/c' and so on. 318 - Edit "Vim:FileType" to match "*.c.*" as well as "*/c" and so on.
319 Add filetype checking too. 319 Add filetype checking too.
320 - Edit `Vim:Menu' and remove all the keys from the menus: > 320 - Edit "Vim:Menu" and remove all the keys from the menus: >
321 :%s/<Tab>[^ \t]*// 321 :%s/<Tab>[^ \t]*//
322 < 322 <
323 vim:tw=78:ts=8:ft=help:norl: 323 vim:tw=78:ts=8:ft=help:norl: