From 679e188ec027978b37eb36a5f2d52bc2cf04ef77 Mon Sep 17 00:00:00 2001 From: mitchell <70453897+667e-11@users.noreply.github.com> Date: Wed, 3 Apr 2013 16:56:14 -0400 Subject: Textadept should support multiple curses platforms; remove ncurses references. Requires Scintilla r4436 and Scinterm r45. --- doc/01_Introduction.md | 4 +-- doc/02_Installation.md | 20 +++++++------- doc/04_WorkingWithFiles.md | 41 ++++++++++++++-------------- doc/05_FileNavigation.md | 10 +++---- doc/06_AdeptEditing.md | 66 +++++++++++++++++++++++----------------------- doc/07_Modules.md | 4 +-- doc/08_Preferences.md | 4 +-- doc/09_Themes.md | 2 +- doc/10_Advanced.md | 8 +++--- doc/12_Compiling.md | 31 +++++++++++----------- doc/13_Help.md | 2 +- doc/14_Appendix.md | 14 +++++----- 12 files changed, 104 insertions(+), 102 deletions(-) (limited to 'doc') diff --git a/doc/01_Introduction.md b/doc/01_Introduction.md index 2c98e04f..ac577111 100644 --- a/doc/01_Introduction.md +++ b/doc/01_Introduction.md @@ -62,8 +62,8 @@ is applicable to key chains: `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 key bindings are mentioned, the Mac OSX and ncurses equivalents are often +When key bindings are mentioned, the Mac OSX and curses equivalents are often 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' (e.g. `Ctrl` to `^`), but this +map to Mac OSX's (e.g. `Ctrl` to `⌘`) or curses' (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. diff --git a/doc/02_Installation.md b/doc/02_Installation.md index c4d1cabc..81980721 100644 --- a/doc/02_Installation.md +++ b/doc/02_Installation.md @@ -6,8 +6,9 @@ In its bid for minimalism, Textadept also needs very little to run. The GUI version needs only [GTK+][], a cross-platform GUI toolkit, version 2.18 or later on Linux and BSD systems. A GTK+ runtime is already bundled into the Windows and Mac OSX packages. Textadept also has its own [copy of Lua][]. The terminal -(ncurses) version of Textadept requires [ncurses][], but that dependency is only -necessary if you wish to run the editor from a terminal. +(curses) version of Textadept requires a curses implementation like [ncurses][], +but that dependency is only necessary if you wish to run the editor from a +terminal. [GTK+]: http://gtk.org [copy of Lua]: 11_Scripting.html#Lua.Configuration @@ -25,11 +26,12 @@ can compile Textadept with earlier versions of GLib down to 2.22. For reference, Ubuntu 11.04, Debian Wheezy, Fedora 15, and openSUSE 11.4 support GLib 2.28 or later. -Most Linux and BSD systems already have ncurses installed. If not, look for it -in your package manager, or compile and install it from the [ncurses website][]. -You need to have or compile the wide-character version of ncurses, which handles -multibyte characters. For Debian-based distributions like Ubuntu, the package is -typically called "libncursesw5". +Most Linux and BSD systems already have a curses implementation like ncurses +installed. If not, look for one in your package manager, or compile and install +ncurses from the [ncurses website][]. You need to have or compile the +wide-character version of ncurses, which handles multibyte characters. For +Debian-based distributions like Ubuntu, the package is typically called +"libncursesw5". [GTK+ website]: http://www.gtk.org/download-linux.html [ncurses website]: http://invisible-island.net/ncurses/#download_ncurses @@ -103,7 +105,7 @@ There is also a *textadeptjit* executable for running Textadept with [LuaJIT][]. Please note there may be [compatibility issues][]. The *textadept* executable is recommended. -The *textadept-ncurses* and *textadeptjit-ncurses* executables are versions of +The *textadept-curses* and *textadeptjit-curses* executables are versions of Textadept for the terminal. Run them as you would run the *textadept* and *textadeptjit* executables, but from a terminal instead. @@ -192,5 +194,5 @@ Textadept.    ![Win32](images/win32.png)    -![ncurses](images/ncurses.png) +![curses](images/ncurses.png) diff --git a/doc/04_WorkingWithFiles.md b/doc/04_WorkingWithFiles.md index 04b4726c..0f8cfd11 100644 --- a/doc/04_WorkingWithFiles.md +++ b/doc/04_WorkingWithFiles.md @@ -9,7 +9,7 @@ single tab bar for multiple views would cause confusion and having one tab bar per view would clutter the interface. Instead of having tabs, Textadept has the buffer browser. Press `Ctrl+B` (`⌘B` -on Mac OSX | `M-B` or `M-S-B` in ncurses) to open it. +on Mac OSX | `M-B` or `M-S-B` in curses) to open it. ![Buffer Browser](images/bufferbrowser.png) @@ -21,7 +21,7 @@ wildcards. You can also just use the arrow keys. Pressing `Enter` or selecting ![Buffer Browser Filtered](images/bufferbrowserfiltered.png) You can see which buffer is active by looking at Textadept's titlebar. Pressing -`Ctrl+Tab` (`^⇥` on Mac OSX | `M-N` in ncurses) cycles to the next buffer and +`Ctrl+Tab` (`^⇥` on Mac OSX | `M-N` in curses) cycles to the next buffer and `Ctrl+Shift+Tab` (`^⇧⇥` | `M-P`) cycles to the previous one. ### Settings @@ -39,7 +39,7 @@ settings in the buffer status statusbar. Indentation is usually set by a [language-specific module][] or the current [theme][]. By default, indentation is 2 spaces. You can toggle between using tabs and spaces manually by pressing `Ctrl+Alt+Shift+T` (`^⇧T` on Mac OSX | -`M-T` or `M-S-T` in ncurses). Toggling between tabs and spaces only affects +`M-T` or `M-S-T` in curses). Toggling between tabs and spaces only affects future indentation; it does not convert existing indentation. `Ctrl+Alt+I` (`^I` | `M-I`) performs the conversion. (If the buffer is using tabs, all indenting spaces are converted to tabs. If the buffer is using spaces, all indenting tabs @@ -78,7 +78,7 @@ alter the encoding of existing files. ### Recent Files -Pressing `Ctrl+Alt+O` (`^⌘O` on Mac OSX | `M-^O` in ncurses) brings up a dialog +Pressing `Ctrl+Alt+O` (`^⌘O` on Mac OSX | `M-^O` in curses) brings up a dialog that behaves like the buffer browser, but displays a list of recently opened files to reopen. @@ -100,7 +100,7 @@ A quicker, though slightly more limited alternative to the standard file selection dialog is snapopen. It behaves like the buffer browser, but displays a list of files to open, including files in sub-directories. You can snapopen the current file's directory with `Ctrl+Alt+Shift+O` (`^⌘⇧O` on Mac OSX | `M-S-O` in -ncurses) or from the "Tools -> Snapopen -> Current Directory" menu. Snapopen is +curses) or from the "Tools -> Snapopen -> Current Directory" menu. Snapopen is pretty limited from the menu, but more versatile in [scripts][]. `Ctrl+U` (`⌘U` | `^U`) snaps open *~/.textadept/*. @@ -115,20 +115,20 @@ pretty limited from the menu, but more versatile in [scripts][]. `Ctrl+U` (`⌘U Textadept allows you to split the editor window as many times as you like both horizontally and vertically. `Ctrl+Alt+S` or `Ctrl+Alt+H` splits horizontally into top and bottom views and `Ctrl+Alt+V` splits vertically (`^S` and `^V` -respectively on Mac OSX | N/A in ncurses) into side-by-side views. 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 opened -in multiple views. +respectively on Mac OSX | N/A in curses) into side-by-side views. 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 opened in multiple +views. -Pressing `Ctrl+Alt+N` (`^⌥⇥` on Mac OSX | N/A in ncurses) goes to the next view +Pressing `Ctrl+Alt+N` (`^⌥⇥` on Mac OSX | N/A in curses) goes to the next view and `Ctrl+Alt+P` (`^⌥⇧⇥` | N/A) goes to the previous one. Note: depending on the split sequence, the order when cycling between views may be unexpected. To unsplit a view, enter the view to keep open and press `Ctrl+Alt+W` (`^W` on -Mac OSX | N/A in ncurses). To unsplit all views, use `Ctrl+Alt+Shift+W` (`^⇧W` | +Mac OSX | N/A in curses). To unsplit all views, use `Ctrl+Alt+Shift+W` (`^⇧W` | N/A). -Split views are unavailable in ncurses. +Split views are unavailable in curses. ### Settings @@ -141,33 +141,32 @@ any other split view. It will have to be done manually. #### Line Endings Normally, EOL characters ("\r" and "\n") are invisible. Pressing -`Ctrl+Alt+Enter` (`^↩` on Mac OSX | none in ncurses) toggles their visibility. +`Ctrl+Alt+Enter` (`^↩` on Mac OSX | none in curses) toggles their visibility. #### Long Lines By default, lines with more characters than the view can show are not wrapped -into view. `Ctrl+Alt+\` (`^\` on Mac OSX | none in ncurses) toggles line +into view. `Ctrl+Alt+\` (`^\` on Mac OSX | none in curses) toggles line wrapping. #### Indentation Guides By default, small guiding lines are shown based on indentation level. -`Ctrl+Alt+Shift+I` (`^⇧I` on Mac OSX | N/A in ncurses) toggles showing these +`Ctrl+Alt+Shift+I` (`^⇧I` on Mac OSX | N/A in curses) toggles showing these guides. -Indentation guides are unavailable in ncurses. +Indentation guides are unavailable in curses. #### Whitespace Normally, whitespace characters, tabs and spaces, are invisible. Pressing -`Ctrl+Alt+Shift+S` (`^⇧S` on Mac OSX | none in ncurses) toggles their -visibility. Visible spaces are shown as dots and visible tabs are shown as -arrows. +`Ctrl+Alt+Shift+S` (`^⇧S` on Mac OSX | none in curses) toggles their visibility. +Visible spaces are shown as dots and visible tabs are shown as arrows. ### Zoom You can temporarily increase or decrease the font size in a view with `Ctrl+=` -(`⌘=` on Mac OSX | N/A in ncurses) and `Ctrl+-` (`⌘-` | N/A) respectively. +(`⌘=` on Mac OSX | N/A in curses) and `Ctrl+-` (`⌘-` | N/A) respectively. `Ctrl+0` (`⌘0` | N/A) resets the zoom. -Zooming is unavailable in ncurses. +Zooming is unavailable in curses. diff --git a/doc/05_FileNavigation.md b/doc/05_FileNavigation.md index 4e21f8fb..4c543e87 100644 --- a/doc/05_FileNavigation.md +++ b/doc/05_FileNavigation.md @@ -5,8 +5,8 @@ Textadept supports the key bindings you are accustomed to for navigating text fields on your platform. The arrow keys move the caret in a particular direction, `Ctrl+Left` and `Ctrl+Right` (`^⇠` and `^⇢` on Mac OSX | `^Left` and -`^Right` in ncurses) move by words, `PgUp` and `PgDn` (`⇞` and `⇟` | `PgUp` and -`PgDn`) move by pages, etc. Mac OSX and ncurses also support some Bash-style +`^Right` in curses) move by words, `PgUp` and `PgDn` (`⇞` and `⇟` | `PgUp` and +`PgDn`) move by pages, etc. Mac OSX and curses also support some Bash-style bindings like `^B`, `^F`, `^P`, `^N`, `^A`, and `^E`. A complete list of movement bindings is found in the "Movement" section of the [key bindings list][]. @@ -17,14 +17,14 @@ movement bindings is found in the "Movement" section of the By default, Textadept will highlight the matching brace characters under the caret : '(', ')', '[', ']', '{', and '}'. Pressing `Ctrl+M` (`^M` on Mac OSX | -`M-M` in ncurses) moves the caret to that matching brace. +`M-M` in curses) moves the caret to that matching brace. ![Matching Braces](images/matchingbrace.png) ## Bookmarks You can place bookmarks on lines in buffers to jump back to them later. -`Ctrl+F2` (`⌘F2` on Mac OSX | `F1` in ncurses) toggles a bookmark on the current +`Ctrl+F2` (`⌘F2` on Mac OSX | `F1` in curses) toggles a bookmark on the current line, `F2` jumps to the next bookmarked line, `Shift+F2` (`⇧F2` | `F3`) jumps to the previously bookmarked line, `Alt+F2` (`⌥F2` | `F4`) jumps to the bookmark selected from a list, and `Ctrl+Shift+F2` (`⌘⇧F2` | `F6`) clears all bookmarks @@ -33,5 +33,5 @@ in the current buffer. ## Goto Line 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` (`↩` | +curses) and specify the line number in the prompt and press `Enter` (`↩` | `Enter`) or select `OK`. diff --git a/doc/06_AdeptEditing.md b/doc/06_AdeptEditing.md index 1ea88ad4..78b3bffc 100644 --- a/doc/06_AdeptEditing.md +++ b/doc/06_AdeptEditing.md @@ -14,7 +14,7 @@ below. Usually, quote (''', '"') and brace ('(', '[', '{') characters go together in pairs. By default, Textadept automatically inserts the complement character when the first is typed. Similarly, the complement is deleted when you -press `Bksp` (`⌫` on Mac OSX | `Bksp` in ncurses) over the first. Typing over +press `Bksp` (`⌫` on Mac OSX | `Bksp` in curses) over the first. Typing over complement characters is also supported. See the [preferences][] page if you would like to disable these features. @@ -23,7 +23,7 @@ would like to disable these features. ### Word Completion Textadept provides buffer-based word completion. Start typing a word, press -`Ctrl+Enter` (`^⎋` on Mac OSX | `M-Enter` in ncurses), and a list of suggested +`Ctrl+Enter` (`^⎋` on Mac OSX | `M-Enter` in curses), and a list of suggested completions based on words in the current buffer is provided. Continuing to type changes the suggestion. Press `Enter` (`↩` | `Enter`) to complete the selected word. @@ -33,7 +33,7 @@ word. ### Virtual Space Mode Virtual space (freehand) mode is enabled and disabled with `Ctrl+Alt+Shift+V` -(`^⇧V` in Mac OSX | none in ncurses). When enabled, caret movement is not +(`^⇧V` in Mac OSX | none in curses). When enabled, caret movement is not restricted by line endings. ### Overwrite Mode @@ -58,11 +58,11 @@ key places an additional caret at that point. Clicking and dragging while holding the same modifier creates multiple selections. When you start typing, the text is mirrored at each selection. -Creating multiple selections with the mouse is currently unavailable in ncurses. +Creating multiple selections with the mouse is currently unavailable in curses. ### Rectangular Selection -Holding `Alt+Shift` (`⌥⇧` on Mac OSX | `M-S-` in ncurses) and pressing the arrow +Holding `Alt+Shift` (`⌥⇧` on Mac OSX | `M-S-` in curses) and pressing the arrow keys enables rectangular selections to be made. Start typing to type on each line. You can also hold the "Alt" modifier key ("Super" on Linux) while clicking and dragging the mouse to create rectangular selections. @@ -79,7 +79,7 @@ change [`buffer.rectangular_selection_modifier`][] in your [theme][]. The to be reconfigured too. Creating rectangular selections with the mouse is currently unavailable in -ncurses. +curses. [`buffer.rectangular_selection_modifier`]: api/buffer.html#rectangular_selection_modifier [theme]: 09_Themes.html#View @@ -87,20 +87,20 @@ ncurses. ### Select to Matching Brace Putting the caret over a brace character ('(', ')', '[', ']', '{', or '}') and -pressing `Ctrl+Shift+M` (`^⇧M` on Mac OSX| `M-S-M` in ncurses) extends the +pressing `Ctrl+Shift+M` (`^⇧M` on Mac OSX| `M-S-M` in curses) extends the selection to the brace character's matching brace. ### Entity Selection Textadept allows you to select many different entities from the caret. For -example, `Ctrl+"` (`^"` on Mac OSX | `M-"` in ncurses) selects all characters in +example, `Ctrl+"` (`^"` on Mac OSX | `M-"` in curses) selects all characters in a double-quoted range. Typing `Ctrl++` (`^+` | `M-+`) as a follow-up selects the double-quotes too. See the "Edit -> Select In..." menu for available entities and their key bindings. ### Marks -In ncurses, since some terminals do not recognize certain key combinations like +In curses, since some terminals do not recognize certain key combinations like `Shift+Arrow` for making selections, you can use marks to create selections. Create a mark at the current caret position with `^^`. Then use regular movement keys like the arrows, page up/down, and home/end to extend the selection in one @@ -110,7 +110,7 @@ type text, delete text, or run a command that does either, the mark is removed and ordinary navigation is restored. You can also press `^^` again to stop selecting text. -Marks are only supported in ncurses. +Marks are only supported in curses. ### Transforms @@ -121,19 +121,19 @@ As a complement to selecting entities, you can enclose text as entities. The their key bindings. If no text is selected, the word to the left of the caret is enclosed. For -example, pressing `Alt+<` (`^<` on Mac OSX | `M->` in ncurses) at the end of a +example, pressing `Alt+<` (`^<` on Mac OSX | `M->` in curses) at the end of a word encloses it in XML tags. #### Change Case Pressing `Ctrl+Alt+U` or `Ctrl+Alt+Shift+U` (`^U` or `^⇧U` on Mac OSX | `M-^U` -or `M-^L` in ncurses) converts selected text to upper case letters or lower case +or `M-^L` in curses) converts selected text to upper case letters or lower case letters respectively. #### Change Indent Level The amount of indentation for a selected set of lines is increased by pressing -`Tab` (`⇥` on Mac OSX | `Tab` in ncurses) and decreased by pressing `Shift+Tab` +`Tab` (`⇥` on Mac OSX | `Tab` in curses) and decreased by pressing `Shift+Tab` (`⇧⇥` | `S-Tab`). Whole lines do not have to be selected. As long as any part of a line is selected, the entire line is eligible for indenting/dedenting. Using these key sequences when no selection is present does not have the same effect. @@ -141,13 +141,13 @@ these key sequences when no selection is present does not have the same effect. #### Move Lines Selected lines are moved with the `Ctrl+Shift+Up` and `Ctrl+Shift+Down` (`^⇧⇡` -and `^⇧⇣` on Mac OSX | `S-^Up` and `S-^Down` in ncurses) keys. Like with -changing indent level, as long as any part of a line is selected, the entire -line is eligible for moving. +and `^⇧⇣` on Mac OSX | `S-^Up` and `S-^Down` in curses) keys. Like with changing +indent level, as long as any part of a line is selected, the entire line is +eligible for moving. ## Find & Replace -`Ctrl+F` (`⌘F` on Mac OSX | `M-F` or `M-S-F` in ncurses) brings up the Find & +`Ctrl+F` (`⌘F` on Mac OSX | `M-F` or `M-S-F` in curses) brings up the Find & Replace pane. In addition to offering the usual find and replace with "Match Case" and "Whole Word" options and find/replace history, Textadept allows you to find with [Lua patterns][] and replace with Lua captures and even Lua code! For @@ -157,12 +157,12 @@ 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 bindings for find next, find previous, replace, and replace all (`⌘G`, `⌘⇧G`, `^R`, `^⇧R` -respectively on Mac OSX | `M-G`, `M-S-G`, `M-R`, `M-S-R` in ncurses) only work +respectively on Mac OSX | `M-G`, `M-S-G`, `M-R`, `M-S-R` in curses) only work when the Find & Replace pane is hidden. When the pane 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, `Tab` and `S-Tab` toggles between the find next, find +In the curses version, `Tab` and `S-Tab` toggles 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. @@ -179,11 +179,11 @@ then "Replace All". ### Find in Files -`Ctrl+Shift+F` brings up Find in Files (`⌘⇧F` on Mac OSX | none in ncurses) and +`Ctrl+Shift+F` brings up Find in Files (`⌘⇧F` on Mac OSX | none in curses) 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 bindings. Replace in Files is not supported. You will have to +in curses) key bindings. 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. @@ -204,7 +204,7 @@ time consuming and frustrating, so using a specialized, external tool such as ### Incremental Find 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 +`M-^F` in curses). Incremental search searches the buffer as you type. Only the "Match Case" option is recognized. Pressing `Esc` (`⎋` | `Esc`) stops the search. @@ -220,8 +220,8 @@ this knowledge to make viewing and editing code faster and easier. When you open a file, chances are that Textadept will identify the programming language associated with that file and set a "lexer" to highlight syntactic elements of the code. You can set or change the lexer manually by pressing -`Ctrl+Shift+L` (`⌘⇧L` on Mac OSX | `M-S-L` in ncurses) and selecting a lexer -from the list. You can customize how Textadept recognizes files in your +`Ctrl+Shift+L` (`⌘⇧L` on Mac OSX | `M-S-L` in curses) and selecting a lexer from +the list. You can customize how Textadept recognizes files in your [file type preferences][]. Lexers can sometimes lose track of their context while you are editing and @@ -234,27 +234,27 @@ highlight syntax incorrectly. Pressing `F5` triggers a full redraw. Some lexers support "code folding", where blocks of code can be temporarily hidden, making viewing easier. Fold points are denoted by arrows in the margin to the left of the code. Clicking on one toggles the folding for that block of -code. You can also press `Ctrl+*` (`⌘*` on Mac OSX | `M-*` in ncurses) to -toggle the fold point on the current line. +code. You can also press `Ctrl+*` (`⌘*` on Mac OSX | `M-*` in curses) to toggle +the fold point on the current line. ![Folding](images/folding.png) ### 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 | N/A in ncurses). This -is useful to show occurrences of a variable name, but is not limited to source +word and pressing `Ctrl+Alt+Shift+H` (`⌘⇧H` on Mac OSX | N/A in curses). This is +useful to show occurrences of a variable name, but is not limited to source code. ![Word Highlight](images/wordhighlight.png) -This is not supported in ncurses. +This is not supported in curses. ### Adeptsense Textadept has the capability to autocomplete symbols for programming languages and display API documentation. Symbol completion is available by pressing -`Ctrl+Space` (`⌥⎋` on Mac OSX | `^Space` in ncurses). Documentation for symbols +`Ctrl+Space` (`⌥⎋` on Mac OSX | `^Space` in curses). Documentation for symbols is available with `Ctrl+H` (`^H` | `M-H` or `M-S-H`). Note: In order for this feature to work, the language you are working with must have an [Adeptsense][] defined. [Language-specific modules][] usually [define Adeptsenses][]. All of @@ -278,7 +278,7 @@ snippets are not limited to static text. They can be dynamic templates which contain placeholders for further user input, can mirror or transform those user inputs, and/or execute arbitrary code. Snippets are useful for rapidly constructing blocks of code such as control structures, method calls, and -function declarations. Press `Ctrl+K` (`⌥⇥` on Mac OSX | `M-K` in ncurses) for a +function declarations. Press `Ctrl+K` (`⌥⇥` on Mac OSX | `M-K` in curses) for a list of available snippets. Snippets are composed of trigger word and snippet text. Instead of manually selecting a snippet, you can type its trigger word followed by the `Tab` (`⇥` | `Tab`) key. Subsequent presses of `Tab` (`⇥` | @@ -298,8 +298,8 @@ own custom snippets in your [snippet preferences][]. ### Toggle Comments -Pressing `Ctrl+/` (`⌘/` on Mac OSX | `M-/` in ncurses) comments or uncomments -the code on the selected lines. As long as any part of a line is selected, the +Pressing `Ctrl+/` (`⌘/` on Mac OSX | `M-/` in curses) comments or uncomments the +code on the selected lines. As long as any part of a line is selected, the entire line will be commented or uncommented. Note: In order for this feature to work, the language you are working with must have its comment prefix defined. Language-specific modules usually [define prefixes][], but it can also be done diff --git a/doc/07_Modules.md b/doc/07_Modules.md index fb8faca1..93347868 100644 --- a/doc/07_Modules.md +++ b/doc/07_Modules.md @@ -31,7 +31,7 @@ perhaps a custom context menu. These features are discussed below. Most language-specific modules have a command that compiles and/or runs the code in the current file. Pressing `Ctrl+Shift+R` (`⌘⇧R` on Mac OSX | `M-^R` in -ncurses) executes the command for compiling code and `Ctrl+R` (`⌘R` | `^R`) +curses) executes the command for compiling code and `Ctrl+R` (`⌘R` | `^R`) executes the command for running code. Double-clicking on any error messages will jump to where the errors occurred. Note: In order for these features to work, the language you are working with must have its compile and run commands @@ -58,7 +58,7 @@ preferences, see the [language module preferences][] section. Most language-specific modules have a set of key bindings for [custom commands][]. See the module's [LuaDoc][] or code to find out which key bindings are assigned. They are typically stored in the `Ctrl+L` (`⌘L` on Mac -OSX | `M-L` in ncurses) key chain prefix. +OSX | `M-L` in curses) key chain prefix. [custom commands]: api/_M.html#Commands [LuaDoc]: api/index.html diff --git a/doc/08_Preferences.md b/doc/08_Preferences.md index ad089fb5..dede2bd6 100644 --- a/doc/08_Preferences.md +++ b/doc/08_Preferences.md @@ -134,8 +134,8 @@ You can add global snippets in *~/.textadept/init.lua*, such as: snippets['path'] = "%<(buffer.filename or ''):match('^.+[/\\]')>" So typing `file` or `path` and then pressing `Tab` (`⇥` on Mac OSX | `Tab` in -ncurses) will insert the snippet, regardless of the current programming -language. You can learn about snippet syntax in the [snippets LuaDoc][]. +curses) will insert the snippet, regardless of the current programming language. +You can learn about snippet syntax in the [snippets LuaDoc][]. [snippets LuaDoc]: api/_M.textadept.snippets.html diff --git a/doc/09_Themes.md b/doc/09_Themes.md index 34d31c4e..3c1de645 100644 --- a/doc/09_Themes.md +++ b/doc/09_Themes.md @@ -69,7 +69,7 @@ documentation or read the [LuaDoc][]. ## Switch Themes You can switch between or reload themes using `Ctrl+Shift+T` (`⌘⇧T` on Mac OSX | -none in ncurses). However, be aware that the views do not reset themselves. Any +none in curses). However, be aware that the views do not reset themselves. Any properties set explicitly in the previous theme's *view.lua* file that are not set explicitly in the new theme will carry over. Restarting Textadept will fix this. Also, be aware that themes apply to all buffers. You cannot assign a theme diff --git a/doc/10_Advanced.md b/doc/10_Advanced.md index 5ac24594..ecf5bc01 100644 --- a/doc/10_Advanced.md +++ b/doc/10_Advanced.md @@ -3,7 +3,7 @@ ## Command Entry Access to the Lua state is available through the command entry. Press `Ctrl+E` -(`⌘E` on Mac OSX | `M-C` in ncurses) to access it. It is useful for debugging, +(`⌘E` on Mac OSX | `M-C` in curses) 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 available commands, see the [Lua API][]. Abbreviated commands for @@ -24,7 +24,7 @@ command line switches. ### Tab Completion Tab-completion for functions, variables, tables, etc. is available. Press the -`Tab` (`⇥` on Mac OSX | `Tab` in ncurses) key to display a list of available +`Tab` (`⇥` on Mac OSX | `Tab` in curses) key to display a list of available completions. Use the arrow keys to make a selection and press `Enter` (`↩` | `Enter`) to insert it. @@ -41,7 +41,7 @@ the implementation. ## Command Selection If you did not disable the menu in your [preferences][], then pressing -`Ctrl+Shift+E` (`⌘⇧E` on Mac OSX | `M-S-C` in ncurses) brings up the command +`Ctrl+Shift+E` (`⌘⇧E` on Mac OSX | `M-S-C` in curses) 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 bindings. It is also useful for looking up @@ -61,7 +61,7 @@ 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 | `^\` in ncurses), +A simpler way would be to press `Ctrl+|` (`⌘|` on Mac OSX | `^\` in curses), enter the shell command `sort`, and hit `Enter` (`↩` | `Enter`). The standard input (stdin) for shell commands is determined as follows: diff --git a/doc/12_Compiling.md b/doc/12_Compiling.md index 2870d5ed..2c1e3ad4 100644 --- a/doc/12_Compiling.md +++ b/doc/12_Compiling.md @@ -18,12 +18,13 @@ Debian-based Linux distributions like Ubuntu, the package is typically called "libgtk2.0-dev". Otherwise, compile and install GTK+ from the [GTK+ website][]. If you would like to compile the terminal version of Textadept, you will need -the ncurses development library. Similarly, it should be available from your -package manager. For Debian-based Linux distributions like Ubuntu, the package -is typically called "libncurses5-dev". Otherwise, compile and install ncurses -from the [ncurses website][]. Note: you need to have the wide-character -development version of ncurses installed, which handles multibyte sequences. -(Therefore, Debian users will _also_ need "libncursesw5-dev".) +the development library for a curses implementation like ncurses. Similarly, one +should be available from your package manager. For Debian-based Linux +distributions like Ubuntu, the ncurses package is typically called +"libncurses5-dev". Otherwise, compile and install ncurses from the +[ncurses website][]. Note: you need to have the wide-character development +version of ncurses installed, which handles multibyte sequences. (Therefore, +Debian users will _also_ need "libncursesw5-dev".) In addition, BSD users will need to have [libiconv][] installed. @@ -68,7 +69,7 @@ For Linux and BSD systems, simply run `make` in the *src/* directory. The *textadept* and *textadeptjit* executables are created in the root directory. Make a symlink from them to */usr/bin/* or elsewhere in your `PATH`. -Similarly, `make ncurses` builds *textadept-ncurses* and *textadeptjit-ncurses*. +Similarly, `make curses` builds *textadept-curses* and *textadeptjit-curses*. Note: you may have to run @@ -87,8 +88,7 @@ a normal Linux application, run the usual `make` and then `make install` or */usr/local* but you can change this by setting `DESTDIR` (e.g. `make install DESTDIR=/prefix/to/install/to`). -Similarly, `make ncurses` and `make ncurses install` installs the ncurses -version. +Similarly, `make curses` and `make curses install` installs the curses version. ### Cross Compiling for Windows @@ -113,8 +113,8 @@ and *../textadeptjit.osx*. At this point it is recommended to build a new *Contents/MacOS/textadept.osx* and *Contents/MacOS/textadeptjit.osx* with your own versions. -Similarly, `make osx-ncurses` builds *../textadept-ncurses.osx* and -*../textadeptjit-ncurses.osx*. +Similarly, `make osx-curses` builds *../textadept-curses.osx* and +*../textadeptjit-curses.osx*. #### Compiling on OSX (Legacy) @@ -137,8 +137,8 @@ Note: to build a GTK+ for OSX bundle, the following needs to be run from the where `username` is replaced with your username. Compiling the terminal version is not so expensive. After uncommenting the -"Darwin" block mentioned above, simply run `make osx-ncurses` to build -*../textadept-ncurses.osx* and *../textadeptjit-ncurses.osx*. No additional +"Darwin" block mentioned above, simply run `make osx-curses` to build +*../textadept-curses.osx* and *../textadeptjit-curses.osx*. No additional libraries are needed. [XCode]: http://developer.apple.com/TOOLS/xcode/ @@ -160,7 +160,7 @@ non-Lua, libraries. ### Notes on CDK -[CDK][] is a library of ncurses widgets. The terminal version of Textadept +[CDK][] is a library of curses widgets. The terminal version of Textadept includes a slightly modified, stripped down version of this library. The changes made to CDK are as follows: @@ -173,7 +173,8 @@ made to CDK are as follows: * *cdk.h* does not `#include` "matrix.h", "viewer.h", and any headers labeled "Generated headers" due to their machine-dependence. * *cdk_config.h* no longer defines `HAVE_SETLOCALE` since Textadept handles - locale settings. + locale settings and no longer defines `HAVE_NCURSES_H` and `NCURSES` since + Textadept supports multiple curses implementations, not just ncurses. * The `deleteFileCB` routine in *fselect.c* has been deactivated. [CDK]: http://invisible-island.net/cdk/ diff --git a/doc/13_Help.md b/doc/13_Help.md index 673c2759..e17008a1 100644 --- a/doc/13_Help.md +++ b/doc/13_Help.md @@ -14,7 +14,7 @@ Switch |Arguments|Description `-s`, `--session` | 1 |Loads [session][] on startup. `-u`, `--userhome` | 1 |Sets alternate [`_USERHOME`][]. -The help switch is unavailable in ncurses. +The help switch is unavailable in curses. [code]: 10_Advanced.html#Command.Entry [unique instance]: 02_Installation.html#Single.Instance diff --git a/doc/14_Appendix.md b/doc/14_Appendix.md index 30f1e56d..adcafac8 100644 --- a/doc/14_Appendix.md +++ b/doc/14_Appendix.md @@ -99,12 +99,12 @@ As a special case, the empty capture `()` captures the current string position [Lua 5.2 Reference Manual]: http://www.lua.org/manual/5.2/manual.html#6.4.1 -## Ncurses Compatibility +## Curses Compatibility -Textadept 5.5 beta introduced an ncurses version that can run in a terminal -emulator. However, since ncurses is quite low-level in terms of graphics -capability compared to GTK+, the ncurses version of Textadept lacks some -features in its editing component Scintilla: +Textadept 5.5 beta introduced a curses version that can run in a terminal +emulator. However, since curses is quite low-level in terms of graphics +capability compared to GTK+, the curses version of Textadept lacks some features +in its editing component Scintilla: * Any settings with alpha values are not supported. * Autocompletion lists cannot show images (pixmap surfaces are not supported). @@ -115,8 +115,8 @@ features in its editing component Scintilla: drawing arrow shapes). * Caret settings like period, line style, and width are not supported (terminals use block carets with their own period definitions). -* Code pages other than UTF-8 have not been tested and it is possible ncurses - does not support them. +* Code pages other than UTF-8 have not been tested and it is possible some + curses implementations do not support them. * Edge lines are not displayed properly (the line is drawn over by text lines). * Extra ascent and decent for lines is not supported. * Fold lines are not supported (`surface->LineTo()` is not supported). -- cgit v1.2.3