From d88a65ae78190eb6a2a94938c93c87c2148c60fc Mon Sep 17 00:00:00 2001 From: mitchell <70453897+orbitalquark@users.noreply.github.com> Date: Mon, 5 Oct 2020 16:07:34 -0400 Subject: Various manual and documentation updates. --- docs/manual.md | 42 ++++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 20 deletions(-) (limited to 'docs/manual.md') 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) +   +![macOS](images/macosx.png) +   +![Win32](images/win32.png) +   +![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 thisa `-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 infoa + +aThe 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) -   -![macOS](images/macosx.png) -   -![Win32](images/win32.png) -   -![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 -------------------------------------------------------------------------------- -- cgit v1.2.3