aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+orbitalquark@users.noreply.github.com>2020-10-05 16:07:34 -0400
committerGravatar mitchell <70453897+orbitalquark@users.noreply.github.com>2020-10-05 16:07:34 -0400
commitd88a65ae78190eb6a2a94938c93c87c2148c60fc (patch)
tree1af5bae41c770b5af529ee0773cf8cfe491dd84b /docs
parent9cbb496e497865077e39eda1f26ae9dbec2ac06b (diff)
Various manual and documentation updates.
Diffstat (limited to 'docs')
-rw-r--r--docs/api.md4
-rw-r--r--docs/changelog.md2
-rw-r--r--docs/manual.md42
3 files changed, 25 insertions, 23 deletions
diff --git a/docs/api.md b/docs/api.md
index 5748da17..57808bb4 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -6304,7 +6304,7 @@ Parameters:
arguments to pass to it. `PATH` is searched for program names.
* *`cwd`*: Optional current working directory (cwd) for the child
process. When omitted, the parent's cwd is used.
-* *`env`*: Optional table of environment variables for the child process.
+* *`env`*: Optional map of environment variables for the child process.
When omitted, the parent's environment is used.
* *`stdout_cb`*: Optional Lua function that accepts a string parameter for a
block of standard output read from the child. Stdout is read asynchronously
@@ -6323,7 +6323,7 @@ Usage:
* `os.spawn('lua ' .. buffer.filename, print)`
* `proc = os.spawn('lua -e "print(io.read())"', print)
- proc:write('foo\n')`
+ proc:write('foo\n')`
Return:
diff --git a/docs/changelog.md b/docs/changelog.md
index c2ce58a7..ac3dfb59 100644
--- a/docs/changelog.md
+++ b/docs/changelog.md
@@ -48,7 +48,7 @@ Bugfixes:
Changes:
-* Rewrote manual and updated lots of other documentation and documentation
+* Rewrote manual and updated lots of other documentation and the documentation
generation pipeline.
* Prefer passing an environment table to `os.spawn()`.
* Updated find & replace key bindings.
diff --git a/docs/manual.md b/docs/manual.md
index d090f323..ceb57973 100644
--- a/docs/manual.md
+++ b/docs/manual.md
@@ -3,7 +3,7 @@
**Contents**
1. [Introduction](#introduction)
-2. [Installation](#installation)
+2. [Getting Started](#getting-started)
3. [User Interface](#user-interface)
4. [Working with Files and Projects](#working-with-files-and-projects)
5. [Adept Editing](#adept-editing)
@@ -161,7 +161,7 @@ assigned to keys, associated with menu items, or connected to events.
[Lua API]: api.html
--------------------------------------------------------------------------------
-### Installation
+### Getting Started
--------------------------------------------------------------------------------
#### Requirements
@@ -230,8 +230,24 @@ your *~/.textadept/init.lua*:
require('file_diff')
require('spellcheck')
+#### Updating
+
+Textadept releases typically occur on the first day of the month every 1-2
+months. There is no auto-update process. (Textadept does not connect to the
+internet; it's just a text editor.) Simply download the new version and copy its
+contents into your current installation, overwriting any existing files and
+directories.
+
#### Running
+![Linux](images/linux.png)
+&nbsp;&nbsp;
+![macOS](images/macosx.png)
+&nbsp;&nbsp;
+![Win32](images/win32.png)
+&nbsp;&nbsp;
+![curses](images/ncurses.png)
+
Run Textadept on Windows by double-clicking *textadept.exe* or
*textadept-curses.exe*. On macOS, double-click *Textadept.app* or invoke the
*ta* script from the command line. On Linux and BSD, invoke *textadept* or
@@ -251,12 +267,14 @@ Switch |Arguments|Description
-------------------|:-------:|-----------
`-e`, `--execute` | 1 |Run the given Lua code
`-f`, `--force` | 0 |Forces unique instance
-`-h`, `--help` | 0 |Shows this (except in the terminal version)
+`-h`, `--help` | 0 |Shows this<sup>a</sup>
`-l`, `--line` | 1 |Jumps to a line in the previously opened file
`-n`, `--nosession`| 0 |No state saving/restoring functionality
`-s`, `--session` | 1 |Loads the given session on startup
`-u`, `--userhome` | 1 |Sets alternate user data directory
-`-v`, `--version` | 0 |Prints Textadept version and copyright information
+`-v`, `--version` | 0 |Prints version and copyright info<sup>a</sup>
+
+<sup>a</sup>The terminal version does not support these.
You can add your own command line arguments using [`args.register()`][]. For
example, in your *~/.textadept/init.lua*:
@@ -346,22 +364,6 @@ distribution to distribution. If you get errors like:
you will need to [compile](#compiling) Textadept manually for your system, which
is a very straightforward and easy process.
-![Linux](images/linux.png)
-&nbsp;&nbsp;
-![macOS](images/macosx.png)
-&nbsp;&nbsp;
-![Win32](images/win32.png)
-&nbsp;&nbsp;
-![curses](images/ncurses.png)
-
-#### Updating
-
-Textadept releases typically occur on the first day of the month every 1-2
-months. There is no auto-update process. (Textadept does not connect to the
-internet; it's just a text editor.) Simply download the new version and copy its
-contents into your current installation, overwriting any existing files and
-directories.
-
--------------------------------------------------------------------------------
### User Interface
--------------------------------------------------------------------------------