diff options
| -rw-r--r-- | doc/01_Introduction.md | 11 | ||||
| -rw-r--r-- | doc/02_Installation.md | 4 | ||||
| -rw-r--r-- | doc/04_WorkingWithFiles.md | 31 | ||||
| -rw-r--r-- | doc/05_FileNavigation.md | 13 | ||||
| -rw-r--r-- | doc/06_AdeptEditing.md | 90 | ||||
| -rw-r--r-- | doc/07_Modules.md | 23 | ||||
| -rw-r--r-- | doc/08_Themes.md | 14 | ||||
| -rw-r--r-- | doc/09_Preferences.md | 4 | ||||
| -rw-r--r-- | doc/10_Advanced.md | 27 |
9 files changed, 119 insertions, 98 deletions
diff --git a/doc/01_Introduction.md b/doc/01_Introduction.md index 46d3dfcf..f22bf831 100644 --- a/doc/01_Introduction.md +++ b/doc/01_Introduction.md @@ -56,8 +56,9 @@ commands on-the-fly to handling UI events. The possibilities are limitless. `Ctrl+N, N` vs. `Ctrl+N, Shift+N`. In the first key chain, `Control` and `N` are pressed followed by `N` with no modifiers. The second has `Control` and `N` pressed followed by `Shift` and `N`. -* When mentioning key commands, the Mac OSX equivalent will often be shown in - parenthesis. It may be tempting to assume that some Windows/Linux keys map to - Mac OSX's (e.g `Ctrl` to `⌘`), but this is not always the case. Please do not - view the key equivalents as translations of one another, but rather as - separate entities. This will minimize confusion. +* When mentioning key commands, the Mac OSX and ncurses equivalents will often + be shown in parenthesis. It may be tempting to assume that some Windows/Linux + keys map to Mac OSX's (e.g `Ctrl` to `⌘`) or ncurses' (`Ctrl` to `^`), but + this is not always the case. Please do not view the key equivalents as + translations of one another, but rather as separate entities. This will + minimize confusion. diff --git a/doc/02_Installation.md b/doc/02_Installation.md index 5de119a4..95ab4003 100644 --- a/doc/02_Installation.md +++ b/doc/02_Installation.md @@ -7,8 +7,8 @@ only thing it needs is [GTK+][] >= 2.18 on Linux systems. GTK is already included in Windows and Mac OSX packages. Textadept also has its own version of Lua. -The _experimental_ terminal version of Textadept requires [ncurses][]. This -dependency is only necessary if you wish to run Textadept from a terminal. +The terminal version of Textadept requires [ncurses][]. This dependency is only +necessary if you wish to run Textadept from a terminal. Notes: diff --git a/doc/04_WorkingWithFiles.md b/doc/04_WorkingWithFiles.md index e5c30d8e..4508e4a1 100644 --- a/doc/04_WorkingWithFiles.md +++ b/doc/04_WorkingWithFiles.md @@ -10,19 +10,19 @@ question of where to place the bar (above, below, or to one side) and how many to have (one for each split view or a single one under the menubar). You can see which buffer is active by looking at Textadept's titlebar. Pressing -`Ctrl+Tab` (`^⇥` on Mac OSX) cycles to the next buffer and `Ctrl+Shift+Tab` -(`^⇧⇥`) cycles to the previous one. +`Ctrl+Tab` (`^⇥` on Mac OSX | `M-N` in ncurses) cycles to the next buffer and +`Ctrl+Shift+Tab` (`^⇧⇥` | `M-P`) cycles to the previous one. ## Buffer Browser -To move quickly between buffers, press `Ctrl+B` (`⌘B` on Mac OSX) to open the -buffer browser. +To move quickly between buffers, press `Ctrl+B` (`⌘B` on Mac OSX | `M-B` or +`M-S-B` in ncurses) to open the buffer browser.  The buffer browser shows you a list of currently open buffers, the most recent towards the bottom. Typing part of any filename filters the list. Spaces are -wildcards. You can also just use the arrow keys. Pressing `Enter` or clicking +wildcards. You can also just use the arrow keys. Pressing `Enter` or selecting `OK` switches to the selected buffer.  @@ -32,15 +32,18 @@ wildcards. You can also just use the arrow keys. Pressing `Enter` or clicking Textadept allows you to split the editor window as many times as you like either horizontally or vertically. `Ctrl+Alt+S` or `Ctrl+Alt+H` splits horizontally (top-bottom) and `Ctrl+Alt+V` splits vertically (`^S` and `^V` respectively on -Mac OSX). You can resize the splitter bar by clicking and dragging with the -mouse or using `Ctrl+Alt++` and `Ctrl+Alt+-` (`^+` and `^-`). The same file can -be worked with in multiple split views. +Mac OSX | N/A in ncurses). You can resize the splitter bar by clicking and +dragging with the mouse or using `Ctrl+Alt++` and `Ctrl+Alt+-` (`^+` and `^-` | +N/A). The same file can be worked with in multiple split views. -Pressing `Ctrl+Alt+N` (`^⌥⇥` on Mac OSX) goes to the next view and `Ctrl+Alt+P` -(`^⌥⇧⇥`) goes to the previous one. +Pressing `Ctrl+Alt+N` (`^⌥⇥` on Mac OSX | N/A in ncurses) goes to the next view +and `Ctrl+Alt+P` (`^⌥⇧⇥` | N/A) goes to the previous one. To unsplit a view, enter the view to keep open and press `Ctrl+Alt+W` (`^W` on -Mac OSX). To unsplit all views, use `Ctrl+Alt+Shift+W` (`^⇧W`). +Mac OSX | N/A in ncurses). To unsplit all views, use `Ctrl+Alt+Shift+W` (`^⇧W` | +N/A). + +Split views are unavailable in ncurses. ## Sessions @@ -60,9 +63,9 @@ A quicker, though slightly more limited alternative to the standard `File -> Open` dialog is snapopen. It behaves like the buffer browser, but displays a list of files to open, including files in subdirectories. You can snapopen the current file's directory with `Ctrl+Alt+Shift+O` (`^⌘⇧O` on Mac -OSX) or from the `Tools -> Snapopen -> Current Directory` menu. Snapopen is -pretty limited from the menu, but more versatile in scripts. See its [LuaDoc][]. -`Ctrl+U` (`⌘U`) snaps open `~/.textadept/`. +OSX | `M-S-O` in ncurses) or from the `Tools -> Snapopen -> Current Directory` +menu. Snapopen is pretty limited from the menu, but more versatile in scripts. +See its [LuaDoc][]. `Ctrl+U` (`⌘U` | `^U`) snaps open `~/.textadept/`. [LuaDoc]: api/_M.textadept.snapopen.html diff --git a/doc/05_FileNavigation.md b/doc/05_FileNavigation.md index 953464a7..93e7f9d9 100644 --- a/doc/05_FileNavigation.md +++ b/doc/05_FileNavigation.md @@ -7,19 +7,20 @@ You can place bookmarks on lines in buffers to jump back to them later. Use the ## Goto Line -To jump to a specific line in a file, press `Ctrl+J` (`⌘J` on Mac OSX) and -specify the line number in the prompt and press `Enter` (`↩`) or click `OK`. +To jump to a specific line in a file, press `Ctrl+J` (`⌘J` on Mac OSX | `^J` in +ncurses) and specify the line number in the prompt and press `Enter` (`↩` | +`Enter`) or select `OK`. ## Goto Matching Brace By default, Textadept will highlight the matching brace characters under the caret : `(`, `)`, `[`, `]`, `{`, `}`, `<`, and `>`. Pressing `Ctrl+M` (`^M` on -Mac OSX) moves the caret to that matching brace and `Ctrl+Shift+M` (`^⇧M`) -extends the selection. +Mac OSX | `M-M` in ncurses) moves the caret to that matching brace and +`Ctrl+Shift+M` (`^⇧M` | `M-S-M`) extends the selection.  -## Mac OSX +## Mac OSX and ncurses Textadept supports the keybindings you are accustomed to for navigating text -fields in Mac OSX. +fields in Mac OSX and entering commands in the Linux/BSD terminal. diff --git a/doc/06_AdeptEditing.md b/doc/06_AdeptEditing.md index 30deac58..b8a5789a 100644 --- a/doc/06_AdeptEditing.md +++ b/doc/06_AdeptEditing.md @@ -22,9 +22,10 @@ to disable this. ## Word Completion Textadept provides buffer-based word completion. Start typing a word, press -`Ctrl+Return` (`^⎋` on Mac OSX), and a list of suggested completions based on -words in the current document is provided. Continuing to type changes the -suggestion. Press `Return` (`↩`) to complete the selected word. +`Ctrl+Return` (`^⎋` on Mac OSX | `M-Enter` in ncurses), and a list of suggested +completions based on words in the current document is provided. Continuing to +type changes the suggestion. Press `Enter` (`↩` | `Enter`) to complete the +selected word.  @@ -33,8 +34,8 @@ suggestion. Press `Return` (`↩`) to complete the selected word. Textadept has the capability to autocomplete symbols for programming languages and display API documentation. Lua is of course supported extremely well and other languages have basic support with the help of [ctags][]. Symbol completion -is available by pressing `Ctrl+Space` (`⌥⎋` on Mac OSX). Documentation for -symbols is available with `Ctrl+H` (`^H`). +is available by pressing `Ctrl+Space` (`⌥⎋` on Mac OSX | `^Space` in ncurses). +Documentation for symbols is available with `Ctrl+H` (`^H` | `M-H` or `M-S-H`).  @@ -50,38 +51,45 @@ the [LuaDoc][]. ## Find and Replace -`Ctrl+F` (`⌘F` on Mac OSX) brings up the Find/Replace dialog. In addition to -offering the usual find and replace, Textadept allows you to find with [Lua -patterns][] and replace with Lua captures and even Lua code! For example: -replacing all `(%w+)` with `%(string.upper('%1'))` capitalizes all words in the -buffer. Lua captures (`%n`) are only available from a Lua pattern search, but -embedded Lua code enclosed in `%()` is always allowed. +`Ctrl+F` (`⌘F` on Mac OSX | `M-F` or `M-S-F` in ncurses) brings up the +Find/Replace dialog. In addition to offering the usual find and replace, +Textadept allows you to find with [Lua patterns][] and replace with Lua captures +and even Lua code! For example: replacing all `(%w+)` with +`%(string.upper('%1'))` capitalizes all words in the buffer. Lua captures (`%n`) +are only available from a Lua pattern search, but embedded Lua code enclosed in +`%()` is always allowed. Note the `Ctrl+G`, `Ctrl+Shift+G`, `Ctrl+Alt+R`, `Ctrl+Alt+Shift+R` key commands for find next, find previous, replace, and replace all (`⌘G`, `⌘⇧G`, `^R`, `^⇧R` -respectively on Mac OSX) only work when the Find/Replace dialog is hidden. When -it is visible, use the button mnemonics: `Alt+N`, `Alt+P`, `Alt+R`, and `Alt+A` -(`⌘N`, `⌘P`, `⌘R`, `⌘A`) for English locale. +respectively on Mac OSX | `M-G`, `M-S-G`, `M-R`, `M-S-R` in ncurses) only work +when the Find/Replace dialog is hidden. When it is visible in the GUI version, +use the button mnemonics: `Alt+N`, `Alt+P`, `Alt+R`, and `Alt+A` (`⌘N`, `⌘P`, +`⌘R`, `⌘A` | N/A) for English locale. + +In the ncurses version, use `Tab` and `S-Tab` to toggle between the find next, +find previous, replace, and replace all buttons; `Up` and `Down` arrows switch +between the find and replace text fields; `^P` and `^N` cycles through history; +and `F1-F4` toggles find options. [Lua patterns]: 14_Appendix.html#Lua.Patterns ### Find in Files -`Ctrl+Shift+F` brings up Find in Files (`⌘⇧F` on Mac OSX) and will prompt for a -directory to search. The results are displayed in a new buffer. Double-clicking -a search result jumps to it in the file. You can also use the `Ctrl+Alt+G` and -`Ctrl+Alt+Shift+G` (`^⌘G` and `^⌘⇧G` on Mac OSX) key commands. Replace in Files -is not supported. You will have to `Find in Files` first, and then `Replace All` -for each file a result is found in. The `Match Case`, `Whole Word`, and -`Lua pattern` flags still apply. +`Ctrl+Shift+F` brings up Find in Files (`⌘⇧F` on Mac OSX | none in ncurses) and +will prompt for a directory to search. The results are displayed in a new +buffer. Double-clicking a search result jumps to it in the file. You can also +use the `Ctrl+Alt+G` and `Ctrl+Alt+Shift+G` (`^⌘G` and `^⌘⇧G` on Mac OSX | none +in ncurses) key commands. Replace in Files is not supported. You will have to +`Find in Files` first, and then `Replace All` for each file a result is found +in. The `Match Case`, `Whole Word`, and `Lua pattern` flags still apply.  ### Find Incremental -You can start an incremental search by pressing `Ctrl+Alt+F` (`^⌘F` on Mac OSX). -Incremental search searches the buffer as you type. Only the `Match Case` option -is recognized. Pressing `Esc` (`⎋`) stops it. +You can start an incremental search by pressing `Ctrl+Alt+F` (`^⌘F` on Mac OSX | +`M-^F` in ncurses). Incremental search searches the buffer as you type. Only the +`Match Case` option is recognized. Pressing `Esc` (`⎋` | `Esc`) stops it. ### Replace in Selection @@ -94,8 +102,9 @@ then `Replace All`. ### Change Indent Level The amount of indentation for a selected set of lines is increased by pressing -`Tab` (`⇥`) and decreased by pressing `Shift+Tab` (`⇧⇥`). Using these key -sequences when no selection is present does not have the same effect. +`Tab` (`⇥` | `Tab`) and decreased by pressing `Shift+Tab` (`⇧⇥` | `S-Tab`). +Using these key sequences when no selection is present does not have the same +effect. ### Change Indent Size @@ -111,8 +120,9 @@ Textadept shows what it is using for indentation in the document statusbar. ### Using Tabs You can use tabs instead of the default spaces by pressing `Ctrl+Alt+Shift+T` -(`^⇧T` on Mac OSX) or using the `Buffer -> Toggle Use Tabs` menu. Textadept -shows what it is using for indentation in the document statusbar. +(`^⇧T` on Mac OSX | `M-T` or `M-S-T` in ncurses) or using the `Buffer -> Toggle +Use Tabs` menu. Textadept shows what it is using for indentation in the document +statusbar. The default option is usually set by a [language-specific module][] or the [theme][]. @@ -130,8 +140,9 @@ all tabs are converted to spaces. ### Rectangular Selection -Holding `Alt+Shift` (`⌥⇧` on Mac OSX) and pressing the arrow keys enables -rectangular selections to be made. Start typing to type on each line. +Holding `Alt+Shift` (`⌥⇧` on Mac OSX | `M-S` in ncurses) and pressing the arrow +keys enables rectangular selections to be made. Start typing to type on each +line.  @@ -143,14 +154,15 @@ Clicking the mouse at a point in the buffer while holding `Control` places an additional caret at that point. Clicking and dragging while holding `Control` creates multiple selections. Start typing to enter text at each selection. -This is currently unavailable on Mac OSX. +This is currently unavailable on Mac OSX and in ncurses. ### Selecting Entities Textadept allows you to select many different entities from the caret. For -example, `Ctrl+"` (`^"` on Mac OSX) selects all characters in a `""` sequence. -Typing `Ctrl++` (`^+`) as a follow-up selects the double-quotes too. See the -`Edit -> Select In...` menu for available entities and their key commands. +example, `Ctrl+"` (`^"` on Mac OSX | `M-"` in ncurses) selects all characters in +a `""` sequence. Typing `Ctrl++` (`^+` | `M-+`) as a follow-up selects the +double-quotes too. See the `Edit -> Select In...` menu for available entities +and their key commands. ## Enclosing Text @@ -163,8 +175,10 @@ If no text is selected, the word to the left of the caret is enclosed. ## Word Highlight All occurrences of a given word are highlighted by putting the caret over the -word and pressing `Ctrl+Alt+Shift+H` (`⌘⇧H` on Mac OSX). This is useful to show -occurrences of a variable name in source code. +word and pressing `Ctrl+Alt+Shift+H` (`⌘⇧H` on Mac OSX | N/A in ncurses). This +is useful to show occurrences of a variable name in source code. + +This is not supported in ncurses.  @@ -173,8 +187,8 @@ occurrences of a variable name in source code. ### Virtual Space Virtual space (freehand) mode is enabled and disabled with `Ctrl+Alt+Shift+V` -(`^⇧V` in Mac OSX). When enabled, caret movement is not restricted by line -endings. +(`^⇧V` in Mac OSX | none in ncurses). When enabled, caret movement is not +restricted by line endings. ### Overwrite diff --git a/doc/07_Modules.md b/doc/07_Modules.md index ea84e32b..afe9f0db 100644 --- a/doc/07_Modules.md +++ b/doc/07_Modules.md @@ -44,12 +44,12 @@ is loaded or a buffer's lexer is set to that language. ### Snippets Most language-specific modules have a set of [snippets][]. Press `Ctrl+K` (`⌥⇥` -on Mac OSX) for a list of available snippets or see the module's Lua code. To -insert a snippet, type its trigger followed by the `Tab` (`⇥`) key. Subsequent -presses of `Tab` (`⇥`) causes the caret to enter tab stops in sequential order, -`Shift+Tab` (`⇧⇥`) goes back to the previous tab stop, and `Ctrl+Shift+K` (`⌥⇧⇥` -on Mac OSX) cancels the current snippet. Snippets can be nested (inserted from -within another snippet). +on Mac OSX | `M-K` in ncurses) for a list of available snippets or see the +module's Lua code. To insert a snippet, type its trigger followed by the `Tab` +(`⇥` | `Tab`) key. Subsequent presses of `Tab` (`⇥` | `Tab`) causes the caret to +enter tab stops in sequential order, `Shift+Tab` (`⇧⇥` | `S-Tab`) goes back to +the previous tab stop, and `Ctrl+Shift+K` (`⌥⇧⇥` | `M-S-K`) cancels the current +snippet. Snippets can be nested (inserted from within another snippet).  @@ -61,24 +61,25 @@ within another snippet). Most language-specific modules have a set of [key commands][]. See the module's Lua code for which key commands are available. They are typically stored in the -`Ctrl+L` (`⌘L` on Mac OSX) key prefix. +`Ctrl+L` (`⌘L` on Mac OSX | `M-L` in ncurses) key prefix. [key commands]: api/_M.textadept.keys.html #### Run Most language-specific modules have a command that runs the code in the current -file. Pressing `Ctrl+R` (`⌘R` on Mac OSX) runs that command. +file. Pressing `Ctrl+R` (`⌘R` on Mac OSX | `^R` in ncurses) runs that command. #### Compile Most language-specific modules have a command that compiles the code in the -current file. Pressing `Ctrl+Shift+R` (`⌘⇧R` on Mac OSX) runs that command. +current file. Pressing `Ctrl+Shift+R` (`⌘⇧R` on Mac OSX | `M-^R` in ncurses) +runs that command. #### Block Comments -Pressing `Ctrl+/` (`⌘/` on Mac OSX) comments or uncomments the code on the -selected lines. +Pressing `Ctrl+/` (`⌘/` on Mac OSX | `M-/` in ncurses) comments or uncomments +the code on the selected lines. ### Buffer Properties diff --git a/doc/08_Themes.md b/doc/08_Themes.md index 64d721c5..9ad71c3f 100644 --- a/doc/08_Themes.md +++ b/doc/08_Themes.md @@ -2,7 +2,7 @@ Textadept's look and feel can be customized with themes. The themes that come with Textadept are `light`, `dark`, and `term`. By default the `light` theme is -used for GUI environments and `term` for terminal environments. To change the +used for the GUI version and `term` for the ncurses version. To change the theme, create a `~/.textadept/theme` and/or `~/.textadept/theme_term` whose first lines of text are the names of the themes you would like to use. @@ -61,12 +61,12 @@ See the [LuaDoc][] for documentation on the properties. ## Testing Themes -You can reload or switch between themes on the fly using `Ctrl+Shift+T` (⌘⇧T on -Mac OSX), but be aware that the Scintilla views do not reset themselves, so any -options set explicitly in the previous theme's `view.lua` file that are not set -explicitly in the new theme will carry over. The switch feature is intended -primarily for theme exploration and/or development and can be slow when many -buffers or views are open. +You can reload or switch between themes on the fly using `Ctrl+Shift+T` (`⌘⇧T` +on Mac OSX | none in ncurses), but be aware that the Scintilla views do not +reset themselves, so any options set explicitly in the previous theme's +`view.lua` file that are not set explicitly in the new theme will carry over. +The switch feature is intended primarily for theme exploration and/or +development and can be slow when many buffers or views are open. Any errors that occur in the theme are printed to `io.stderr`. diff --git a/doc/09_Preferences.md b/doc/09_Preferences.md index 4c648e8e..64f63dbd 100644 --- a/doc/09_Preferences.md +++ b/doc/09_Preferences.md @@ -67,8 +67,8 @@ You can add global snippets to `snippets` such as: snippets['file'] = '%<buffer.filename>' snippets['path'] = "%<(buffer.filename or ''):match('^.+[/\\]')>" -So typing `file` or `path` and then pressing `Tab` (`⇥` on Mac OSX) will insert -the snippet. +So typing `file` or `path` and then pressing `Tab` (`⇥` on Mac OSX | `Tab` in +ncurses) will insert the snippet. #### Key Commands diff --git a/doc/10_Advanced.md b/doc/10_Advanced.md index 21cb29ae..adae9ad7 100644 --- a/doc/10_Advanced.md +++ b/doc/10_Advanced.md @@ -3,10 +3,10 @@ ## Command Entry Access to the Lua state is available through the command entry. Press `Ctrl+E` -(`⌘E` on Mac OSX) to access it. It is useful for debugging, inspecting, and -entering buffer or view commands. If you try to cause instability in Textadept's -Lua state, you might very well succeed so be careful. For more information, see -the [scripting][] page. +(`⌘E` on Mac OSX | `M-C` in ncurses) to access it. It is useful for debugging, +inspecting, and entering buffer or view commands. If you try to cause +instability in Textadept's Lua state, you might very well succeed so be careful. +For more information, see the [scripting][] page. Abbreviated commands for the `buffer`, `view` and `gui` are available. So `buffer:append_text('foo')` can be shortened to `append_text('foo')`. `print()` @@ -20,8 +20,9 @@ redirects to [`gui.print()`][]. Use `_G.print()` for Lua's `print()`. ### Tab Completion Tab-completion for functions, variables, tables, etc. is available. Press the -`Tab` (`⇥`) key to display a list of available completions. Use the arrow keys -to make a selection and press `Enter` (`↩`) to insert it. +`Tab` (`⇥` on Mac OSX | `Tab` in ncurses) key to display a list of available +completions. Use the arrow keys to make a selection and press `Enter` (`↩` | +`Enter`) to insert it.  @@ -36,11 +37,11 @@ the implementation. ## Command Selection If you did not disable the menu in your [preferences][], then pressing -`Ctrl+Shift+E` (`⌘⇧E` on Mac OSX) brings up the command selection dialog. Typing -part of any command filters the list with spaces being wildcards. This is an -easy way to run commands without navigating the menus, using the mouse, or -remembering key commands. It is also useful for looking up particular key -commands quickly. +`Ctrl+Shift+E` (`⌘⇧E` on Mac OSX | `M-S-C` in ncurses) brings up the command +selection dialog. Typing part of any command filters the list with spaces being +wildcards. This is an easy way to run commands without navigating the menus, +using the mouse, or remembering key commands. It is also useful for looking up +particular key commands quickly. [preferences]: 9_Preferences.html#User.Init @@ -53,8 +54,8 @@ buffer (or a selection). You could do the following from the command entry: ls={}; for l in buffer:get_text():gmatch('[^\n]+') do ls[#ls+1]=l end; table.sort(ls); buffer:set_text(table.concat(ls, '\n')) -A simpler way would be to press `Ctrl+|` (`⌘|` on Mac OSX), enter the shell -command `sort`, and hit `Enter` (`↩`). +A simpler way would be to press `Ctrl+|` (`⌘|` on Mac OSX | `^\` in ncurses), +enter the shell command `sort`, and hit `Enter` (`↩` | `Enter`). The standard input (stdin) for shell commands is determined as follows: |