From 2b7c10033464fd144b45719311965b12017713c2 Mon Sep 17 00:00:00 2001 From: Tim Allen Date: Thu, 24 Jan 2019 08:50:52 +1100 Subject: [PATCH 1/3] doc/kak.1: make the config-loading description a top-level paragraph. Previously, it was indented to look like part of the description of the file parameter. --- doc/kak.1 | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/kak.1 b/doc/kak.1 index e40ae56a..e13d112e 100644 --- a/doc/kak.1 +++ b/doc/kak.1 @@ -105,6 +105,7 @@ line of the file .BR file one or more \fIfile\fRs to edit +.PP At startup, if \fB\-n\fR is not specified, Kakoune will try to source the file \fI../share/kak/kakrc\fR relative to the kak binary. This kak file will then try to recursively source any files in \fI$XDG_CONFIG_HOME/kak/autoload\fR From d712454b3c7646f21a55662d80e8b095177d70c9 Mon Sep 17 00:00:00 2001 From: Tim Allen Date: Thu, 24 Jan 2019 08:52:01 +1100 Subject: [PATCH 2/3] doc/kak.1: split the synopsis for each mutually exclusive mode of operation. Previously, the manpage listed every flag and parameter as optional, implying that they could be used in any combination, which isn't true. As a trivial example, to use Kakoune in "list sessions" mode, you *must* specify -l, and you *must not* specify any other options. To use Kakoune in any other mode, you *must not* specify -l. --- doc/kak.1 | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/doc/kak.1 b/doc/kak.1 index e13d112e..2e887a83 100644 --- a/doc/kak.1 +++ b/doc/kak.1 @@ -6,8 +6,44 @@ kak \- a vim inspired, selection oriented code editor .SH SYNOPSIS +.PP +.B kak \-help + +.PP +.B kak \-version + +.PP +.B kak \-l + +.PP +.B kak \-clear + +.PP +.B kak \-f +.I keys +[\fB\-q\fR] [\fB\-i\fR] +.IR file ... + +.PP +.B kak \-p +.I session_id + +.PP +.B kak \-s +.I session_id +.B \-d +[\fB\-n\fR] [\fB\-ro\fR] +[\fB\-E\fR \fIcommand\fR] +[\fB+line\fR[\fB:column\fR]|\fB+:\fR] +.IR file ... + +.PP .B kak -[\fB\-help\fR] [\fB\-version\fR] [\fB\-q\fR] [\fB\-n\fR] [\fB\-l\fR] [\fB\-ro\fR] [\fB\-clear\fR] [\fB\-ui\fR \fIui_type\fR] [\fB\-e\fR \fIcommand\fR] [\fB\-E\fR \fIcommand\fR] [\fB\-f\fR \fIkeys\fR] [\fB\-p\fR \fIsession_id\fR] [\fB\-c\fR \fIsession_id\fR|[[\fB\-d\fR] \fB\-s\fR \fIsession_id\fR] [\fB+line\fR[\fB:column\fR]|\fB+:\fR] +[\fB\-c\fR \fIsession_id\fR|\fB\-s\fR \fIsession_id\fR] +[\fB\-n\fR] [\fB\-ro\fR] +[\fB\-ui\fR \fIui_type\fR] [\fB\-e\fR \fIcommand\fR] +[\fB\-E\fR \fIcommand\fR] +[\fB+line\fR[\fB:column\fR]|\fB+:\fR] .IR file ... .SH DESCRIPTION From 64ea32d5c3cb0ea811ec2555dd18322553c710a4 Mon Sep 17 00:00:00 2001 From: Tim Allen Date: Thu, 24 Jan 2019 09:09:07 +1100 Subject: [PATCH 3/3] doc/kak.1: Mention other sources of information about Kakoune. Also add a SEE ALSO section because it's traditional, and a good way to indicate Kakoune's sources and inspirations. --- doc/kak.1 | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/kak.1 b/doc/kak.1 index 2e887a83..9dec4890 100644 --- a/doc/kak.1 +++ b/doc/kak.1 @@ -65,6 +65,10 @@ characters, selections have an anchor and a cursor character. Most commands move both of them, except when extending selection where the anchor character stays fixed and the cursor one moves around. +For more information, use the \fB:doc\fR command after starting Kakoune, +the Kakoune wiki at https://github.com/mawww/kakoune/wiki +or the main Kakoune web site: https://kakoune.org/ + .SH OPTIONS .TP @@ -208,3 +212,9 @@ After that, if it exists, source the \fI$XDG_CONFIG_HOME/kak/kakrc\fR file which should be used for user configuration. In order to continue autoloading site\-wide files with a local autoload directory, just add a symbolic link to \fI../share/kak/autoload\fR into your local autoload directory. + +.SH SEE ALSO + +.BR vi (1), +.BR vim (1), +.BR sam (1plan9)