xenia/kakoune
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc/kak.1: split the synopsis for each mutually exclusive mode of operation.

Browse Source 
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.
This commit is contained in:
Tim Allen 2019-01-24 08:52:01 +11:00
parent 2b7c100334
commit d712454b3c
1 changed files with 37 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
doc/kak.1
View File

@ -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