From b9d8c1501411b6bdc795cba3fdce6a52dc676df1 Mon Sep 17 00:00:00 2001
From: Simon Michael <simon@joyful.com>
Date: Fri, 24 Jun 2016 19:26:53 -0700
Subject: [PATCH] ui: doc: clarify which editors support positioning

---
 hledger-ui/doc/hledger-ui.1       | 12 ++++++------
 hledger-ui/doc/hledger-ui.1.info  | 30 +++++++++++++++---------------
 hledger-ui/doc/hledger-ui.1.m4.md |  7 ++++---
 hledger-ui/doc/hledger-ui.1.txt   | 10 +++++-----
 4 files changed, 30 insertions(+), 29 deletions(-)

diff --git a/hledger-ui/doc/hledger-ui.1 b/hledger-ui/doc/hledger-ui.1
index 7a78b2241..ca092120c 100644
--- a/hledger-ui/doc/hledger-ui.1
+++ b/hledger-ui/doc/hledger-ui.1
@@ -250,12 +250,12 @@ and any previous screens.
 updated file.
 This allows some basic data entry.
 .PP
-\f[C]E\f[] runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacs) on
-the journal file.
-When invoked from the register and transaction screens, the cursor will
-be positioned at the current transaction.
-When invoked from the error screen, the cursor will be at the error
-location (if possible).
+\f[C]E\f[] runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default
+(\f[C]emacsclient\ \-a\ ""\ \-nw\f[]) on the journal file.
+With some editors (emacs, vi), the cursor will be positioned at the
+current transaction when invoked from the register and transaction
+screens, and at the error location (if possible) when invoked from the
+error screen.
 .PP
 \f[C]q\f[] quits the application.
 .PP
diff --git a/hledger-ui/doc/hledger-ui.1.info b/hledger-ui/doc/hledger-ui.1.info
index 5f49e72a7..1d3786563 100644
--- a/hledger-ui/doc/hledger-ui.1.info
+++ b/hledger-ui/doc/hledger-ui.1.info
@@ -180,11 +180,11 @@ pause.)
    `a' runs command-line hledger's add command, and reloads the updated
 file. This allows some basic data entry.
 
-   `E' runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacs) on the
-journal file. When invoked from the register and transaction screens,
-the cursor will be positioned at the current transaction. When invoked
-from the error screen, the cursor will be at the error location (if
-possible).
+   `E' runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (`emacsclient
+-a "" -nw') on the journal file. With some editors (emacs, vi), the
+cursor will be positioned at the current transaction when invoked from
+the register and transaction screens, and at the error location (if
+possible) when invoked from the error screen.
 
    `q' quits the application.
 
@@ -335,15 +335,15 @@ Node: OPTIONS825
 Ref: #options924
 Node: KEYS3800
 Ref: #keys3897
-Node: SCREENS5474
-Ref: #screens5561
-Node: Accounts screen5651
-Ref: #accounts-screen5781
-Node: Register screen7086
-Ref: #register-screen7243
-Node: Transaction screen9064
-Ref: #transaction-screen9224
-Node: Error screen10091
-Ref: #error-screen10215
+Node: SCREENS5506
+Ref: #screens5593
+Node: Accounts screen5683
+Ref: #accounts-screen5813
+Node: Register screen7118
+Ref: #register-screen7275
+Node: Transaction screen9096
+Ref: #transaction-screen9256
+Node: Error screen10123
+Ref: #error-screen10247
 
 End Tag Table
diff --git a/hledger-ui/doc/hledger-ui.1.m4.md b/hledger-ui/doc/hledger-ui.1.m4.md
index a0f8a9887..29121935d 100644
--- a/hledger-ui/doc/hledger-ui.1.m4.md
+++ b/hledger-ui/doc/hledger-ui.1.m4.md
@@ -103,9 +103,10 @@ previous screens. (With large files, there can be a noticeable pause.)
 `a` runs command-line hledger's add command, and reloads the updated file.
 This allows some basic data entry. 
 
-`E` runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacs) on the journal file.
-When invoked from the register and transaction screens, the cursor will be positioned at the current transaction.
-When invoked from the error screen, the cursor will be at the error location (if possible).
+`E` runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (`emacsclient -a "" -nw`) on the journal file.
+With some editors (emacs, vi), the cursor will be positioned at the current transaction
+when invoked from the register and transaction screens, and at the error location (if possible)
+when invoked from the error screen. 
 
 `q` quits the application.
 
diff --git a/hledger-ui/doc/hledger-ui.1.txt b/hledger-ui/doc/hledger-ui.1.txt
index 5d4ed4abf..90d0d6fd3 100644
--- a/hledger-ui/doc/hledger-ui.1.txt
+++ b/hledger-ui/doc/hledger-ui.1.txt
@@ -167,11 +167,11 @@ KEYS
        a runs command-line hledger's add  command,  and  reloads  the  updated
        file.  This allows some basic data entry.
 
-       E  runs  $HLEDGER_UI_EDITOR,  or  $EDITOR,  or a default (emacs) on the
-       journal file.  When invoked from the register and transaction  screens,
-       the cursor will be positioned at the current transaction.  When invoked
-       from the error screen, the cursor will be at  the  error  location  (if
-       possible).
+       E   runs   $HLEDGER_UI_EDITOR,   or   $EDITOR,   or  a  default  (emac-
+       sclient -a "" -nw) on the journal file.  With some editors (emacs, vi),
+       the  cursor  will be positioned at the current transaction when invoked
+       from the register and transaction screens, and at  the  error  location
+       (if possible) when invoked from the error screen.
 
        q quits the application.