wordgrinder.man

.\"                                      Hey, EMACS: -*- nroff -*-
.TH WORDGRINDER 1 "@@@DATE@@@" "@@@VERSION@@@" "Simple word processor for writing first drafts"
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
wordgrinder \- console-based word processor



.SH SYNOPSIS

.B wordgrinder
.RI [ options ]
.RI [ filename ]



.SH DESCRIPTION

.B wordgrinder
is a simple character cell word processor that runs on the console. It is
primarily designed for text entry. It's designed to get the hell out of
your way and let you write; it does very little, but what it does it does well.

It supports Unicode, basic paragraph styles, basic character styles, basic screen
markup, a menu interface that means you don't have to remember complex
key sequences, HTML import and export, and some other useful features.

When running, pressing ESC (or ALT + menu shortcut key) will open the menu.



.SH OPTIONS

These options follow the usual GNU command line syntax, with long
options starting with two dashes (`-').

.TP
.B \-h, \-\-help
Show summary of options.

.TP
.BI \--lua\  filename
Loads and executes a Lua file instead of starting normally.

.TP
.BI \--convert\  srcfile\ destfile
Converts from
.I srcfile
to
.I destfile
and then exits.

The type of the file is autodetected from the extension of the filename. The
source file may have a document name suffixed with a
.I :
for use when importing or exporting WordGrinder files.

.TP
.BI \--config\  file.lua
Sets the name of the user config file.

.TP
.B -8
Forces 8-bit ISO-8859-1 mode. No Unicode drawing characters are used and
non-ISO-8859-1 characters are drawn as question marks.

.TP
.B --no-ncurses-colour
Forces ncurses not to enable colour support, even if the terminal claims it has
it. This is intended for use when the terminal's colour support is broken.

.TP
.B --recent
On startup, loads the most recent file edited by WordGrinder. If there is no
most recent file, you get an empty document.

.SH CONFIGURATION

The user config file is a Lua file which is loaded and executed before
the program starts up. It defaults to:

.TP
.B ~/.wordgrinder/startup.lua


.SH AUTHOR
.B wordgrinder
was written by David Given.
.br
http://cowlark.com/wordgrinder