diff options
author | mitchell <70453897+667e-11@users.noreply.github.com> | 2012-06-27 15:17:53 -0400 |
---|---|---|
committer | mitchell <70453897+667e-11@users.noreply.github.com> | 2012-06-27 15:17:53 -0400 |
commit | fb7e2d2d29485ed4698cbb0c873c189a9660cdb7 (patch) | |
tree | bf2965ac52aba2ad5cdf15f2aa0717cd9f20475a | |
parent | 85c589f9228d829741246a11982014e5e580a9a1 (diff) |
Updated the manual, README, and FAQ with new ncurses information.
-rw-r--r-- | FAQ.md | 10 | ||||
-rw-r--r-- | README.md | 7 | ||||
-rw-r--r-- | doc/02_Installation.md | 33 | ||||
-rw-r--r-- | doc/03_UserInterface.md | 16 | ||||
-rw-r--r-- | doc/12_Compiling.md | 14 |
5 files changed, 52 insertions, 28 deletions
@@ -8,14 +8,12 @@ How do I fix it? **A:** It is difficult to provide a binary that runs on all Linux platforms since the library versions installed vary widely from distribution to distribution. For -example, `libpng14` has been available for my Archlinux distribution since late -2009 while the late 2010 Ubuntu still uses `libpng12`. Unfortunately in these +example, `libpng14` has been available for many distributions since late 2009 +while the latest 2012 Ubuntu still uses `libpng12`. Unfortunately in these cases, the best idea is to compile Textadept. This process is actually very simple though. See the [compiling][] page. Only the GTK development libraries -are needed. - -If you get a `libpng12` error, try using the `textadept.lpng12` executable -instead of `textadept`. +are needed for the GUI version. (The ncurses and CDK development libraries are +required for the terminal version.) [compiling]: 12_Compiling.html @@ -14,7 +14,7 @@ sacrificing speed or succumbing to code bloat and featuritis. * Self-contained executable -- no installation necessary. * Entirely keyboard driven. -* Unlimited split views. +* Unlimited split views (GUI version). * Support for over 80 programming languages. * Powerful snippets and key commands. * Code autocompletion and API lookup. @@ -27,7 +27,12 @@ operating systems and depends only on [GTK+ 2.0][] version 2.16 or greater on Linux. Lua is pre-compiled into Textadept on all platforms and a GTK runtime is included on Windows and Mac OSX. +The _experimental_ version of Textadept for the terminal requires only +[ncurses][] and [CDK][]. + [GTK+ 2.0]: http://gtk.org +[ncurses]: http://invisible-island.net/ncurses/ncurses.html +[CDK]: http://invisible-island.net/cdk/ ## Download diff --git a/doc/02_Installation.md b/doc/02_Installation.md index 5162df3f..fc6c5d61 100644 --- a/doc/02_Installation.md +++ b/doc/02_Installation.md @@ -7,6 +7,10 @@ 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][] and +[CDK][]. These dependencies are only necessary if you wish to run Textadept from +a terminal. + Notes: * The Linux binaries provided require GLib >= 2.28 to support single-instance @@ -18,6 +22,8 @@ Notes: uses. Textadept itself is much smaller. [GTK+]: http://gtk.org +[ncurses]: http://invisible-island.net/ncurses/ncurses.html +[CDK]: http://invisible-island.net/cdk/ ### Linux @@ -25,7 +31,14 @@ Most Linux systems already have GTK+ installed. If not, it is probably available through your package manager. Otherwise, compile and install it from the [GTK+ website][]. +Most Linux systems already have ncurses installed, but probably not CDK. Look +for them in your package manager, or compile and install them from their +[respective][] [websites][]. For Debian-based distributions like Ubuntu, the +packages are typically called `libncursesw5` and `libcdk5`. + [GTK+ website]: http://www.gtk.org/download-linux.html +[respective]: http://invisible-island.net/ncurses/#download_ncurses +[websites]: http://invisible-island.net/cdk/#download ### Mac OSX @@ -92,6 +105,9 @@ 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 version of +Textadept for the terminal. + [LuaJIT]: http://luajit.org [compatibility issues]: 11_Scripting.html#LuaJIT @@ -102,17 +118,9 @@ since the versions of software installed vary widely from distribution to distribution. Because the Linux version of Textadept uses the version of GTK+ installed on your system, an error like: `error while loading shared libraries: <lib>: cannot open shared object file: No such file or directory` may occur when -trying to run the program. - -The most common occurance of this error is for the `libpng12` library on 64-bit -(x86\_64) Debian and Debian-based Linux distributions like Ubuntu because -`libpng12` has not been replaced in favor of the newer `libpng14`. If you are -experiencing this error, simply rename `textadept.lpng12` to `textadept`. The -former has been compiled to use `libpng12`. - -If the above situation did not apply to you, do not be alarmed. The solution is -actually quite painless even though it requires recompiling Textadept. See the -[compiling][] page for more information. +trying to run the program. The solution is actually quite painless even though +it requires recompiling Textadept. See the [compiling][] page for more +information. [compiling]: 12_Compiling.html @@ -165,7 +173,8 @@ passing a `-f` or `--force` switch to Textadept: `textadept -f file.ext` (`ta -f file.ext`). When the force switch is not present, files will be opened in the original Textadept instance, regardless of how many instances are open. -Single instance is not supported on Windows. +Single instance is not supported on the Windows and terminal versions of +Textadept. ![Linux](images/linux.png) diff --git a/doc/03_UserInterface.md b/doc/03_UserInterface.md index bda4d1fe..0bbb3d5e 100644 --- a/doc/03_UserInterface.md +++ b/doc/03_UserInterface.md @@ -2,20 +2,24 @@ ![UI](images/ui.png) -Textadept's user interface was designed to be simple. It consists of a menubar, -editor view, initially hidden find/replace dialog, initially hidden command -entry, and statusbar. Below are brief descriptions of these features. More -in-depth discussion about some of them is provided later in the manual. +Textadept's user interface was designed to be simple. It consists of a menubar +(GUI version), editor view, initially hidden find/replace dialog, initially +hidden command entry, and statusbar. Below are brief descriptions of these +features. More in-depth discussion about some of them is provided later in the +manual. ## Menubar The completely customizable (and optional!) menubar provides access to all of -Textadept's features. +Textadept's features. It is only available in the GUI version of Textadept. +In the terminal, you can use the +[command selection](10_Advance.html#Command.Selection) dialog instead. ## Editor View The editor view is where you will spend most of your time in Textadept. It -supports unlimited split views and is completely controllable by Lua. +supports unlimited split views (GUI version) and is completely controllable by +Lua. ## Find and Replace Dialog diff --git a/doc/12_Compiling.md b/doc/12_Compiling.md index 2792f6f8..423cdbdb 100644 --- a/doc/12_Compiling.md +++ b/doc/12_Compiling.md @@ -15,9 +15,17 @@ from the [GTK+ website][]. Additionally you will need the [GNU C compiler][] distribution through its package manager. For example, Ubuntu includes these tools in the `build-essential` package. +If you would like to compile the terminal version of Textadept, you will need +the ncurses and CDK development libraries. Similarly, they should be available +from your package manager. For Debian-based distributions like Ubuntu, the +packages are typically called `libncurses5-dev` and `libcdk5-dev`. Otherwise, +compile and install them from their [respective][] [websites][]. + [GTK+ website]: http://www.gtk.org/download/linux.html [GNU C compiler]: http://gcc.gnu.org [GNU Make]: http://www.gnu.org/software/make/ +[respective]: http://invisible-island.net/ncurses/#download_ncurses +[websites]: http://invisible-island.net/cdk/#download ### Windows @@ -61,9 +69,9 @@ either run `make win32`, modify the `CROSS` variable in the `win32` block of `src/Makefile` and run `make win32`, or run `make CROSS=i486-mingw32- win32` to build `../textadept.exe` and `../textadeptjit.exe`. -Please note that a `lua51.dll` is produced for Windows platforms because -limitations on external Lua library loading do not allow statically linking -LuaJIT to Textadept. Static linking occurs on all other platforms. +Please note that a `lua51.dll` is produced for _only_ the `textadeptjit.exe` +because limitations on external Lua library loading do not allow statically +linking LuaJIT to Textadept. ### Mac OSX |