;doc: update manuals

hledger-ui/hledger-ui.1

@@ -4,7 +4,8 @@
 
 
 .SH NAME
-hledger\-ui \- robust, friendly plain text accounting (TUI version)
+hledger\-ui \- terminal interface (TUI) for \f[CR]hledger\f[R], a
+robust, friendly plain text accounting app.
 .SH SYNOPSIS
 \f[CR]hledger\-ui    [OPTS] [QUERYARGS]\f[R]
 .PD 0

hledger-ui/hledger-ui.info

@@ -11,7 +11,8 @@ File: hledger-ui.info,  Node: Top,  Next: OPTIONS,  Up: (dir)
 hledger-ui(1)
 *************
 
-hledger-ui - robust, friendly plain text accounting (TUI version)
+hledger-ui - terminal interface (TUI) for 'hledger', a robust, friendly
+plain text accounting app.
 
    'hledger-ui [OPTS] [QUERYARGS]'
 'hledger ui -- [OPTS] [QUERYARGS]'
@@ -580,42 +581,42 @@ above).
 
 Tag Table:
 Node: Top221
-Node: OPTIONS1830
+Node: OPTIONS1863
-Ref: #options1928
+Ref: #options1961
-Node: General options2895
+Node: General options2928
-Ref: #general-options2999
+Ref: #general-options3032
-Node: MOUSE8149
+Node: MOUSE8182
-Ref: #mouse8244
+Ref: #mouse8277
-Node: KEYS8481
+Node: KEYS8514
-Ref: #keys8574
+Ref: #keys8607
-Node: SCREENS13229
+Node: SCREENS13262
-Ref: #screens13327
+Ref: #screens13360
-Node: Menu screen13963
+Node: Menu screen13996
-Ref: #menu-screen14084
+Ref: #menu-screen14117
-Node: Cash accounts screen14279
+Node: Cash accounts screen14312
-Ref: #cash-accounts-screen14456
+Ref: #cash-accounts-screen14489
-Node: Balance sheet accounts screen14640
+Node: Balance sheet accounts screen14673
-Ref: #balance-sheet-accounts-screen14856
+Ref: #balance-sheet-accounts-screen14889
-Node: Income statement accounts screen14976
+Node: Income statement accounts screen15009
-Ref: #income-statement-accounts-screen15197
+Ref: #income-statement-accounts-screen15230
-Node: All accounts screen15361
+Node: All accounts screen15394
-Ref: #all-accounts-screen15542
+Ref: #all-accounts-screen15575
-Node: Register screen15724
+Node: Register screen15757
-Ref: #register-screen15883
+Ref: #register-screen15916
-Node: Transaction screen18167
+Node: Transaction screen18200
-Ref: #transaction-screen18325
+Ref: #transaction-screen18358
-Node: Error screen19742
+Node: Error screen19775
-Ref: #error-screen19864
+Ref: #error-screen19897
-Node: TIPS20108
+Node: TIPS20141
-Ref: #tips20207
+Ref: #tips20240
-Node: Watch mode20249
+Node: Watch mode20282
-Ref: #watch-mode20356
+Ref: #watch-mode20389
-Node: Debug output21815
+Node: Debug output21848
-Ref: #debug-output21926
+Ref: #debug-output21959
-Node: ENVIRONMENT22138
+Node: ENVIRONMENT22171
-Ref: #environment22248
+Ref: #environment22281
-Node: BUGS22439
+Node: BUGS22472
-Ref: #bugs22522
+Ref: #bugs22555
 
 End Tag Table
 

hledger-ui/hledger-ui.txt

@@ -2,7 +2,8 @@
 HLEDGER-UI(1)                hledger User Manuals                HLEDGER-UI(1)
 
 NAME
-       hledger-ui - robust, friendly plain text accounting (TUI version)
+       hledger-ui  -  terminal interface (TUI) for hledger, a robust, friendly
+       plain text accounting app.
 
 SYNOPSIS
        hledger-ui    [OPTS] [QUERYARGS]

hledger-web/hledger-web.1

@@ -4,7 +4,8 @@
 
 
 .SH NAME
-hledger\-web \- robust, friendly plain text accounting (Web version)
+hledger\-web \- web interface and API for \f[CR]hledger\f[R], a robust,
+friendly plain text accounting app.
 .SH SYNOPSIS
 \f[CR]hledger\-web    [\-\-serve|\-\-serve\-api] [OPTS] [ARGS]\f[R]
 .PD 0

hledger-web/hledger-web.info

@@ -11,7 +11,8 @@ File: hledger-web.info,  Node: Top,  Next: OPTIONS,  Up: (dir)
 hledger-web(1)
 **************
 
-hledger-web - robust, friendly plain text accounting (Web version)
+hledger-web - web interface and API for 'hledger', a robust, friendly
+plain text accounting app.
 
    'hledger-web [--serve|--serve-api] [OPTS] [ARGS]'
 'hledger web -- [--serve|--serve-api] [OPTS] [ARGS]'
@@ -547,26 +548,26 @@ http://bugs.hledger.org), or on the #hledger chat or hledger mail list
 
 Tag Table:
 Node: Top223
-Node: OPTIONS2578
+Node: OPTIONS2608
-Ref: #options2683
+Ref: #options2713
-Node: General options5587
+Node: General options5617
-Ref: #general-options5692
+Ref: #general-options5722
-Node: PERMISSIONS10842
+Node: PERMISSIONS10872
-Ref: #permissions10981
+Ref: #permissions11011
-Node: EDITING UPLOADING DOWNLOADING12193
+Node: EDITING UPLOADING DOWNLOADING12223
-Ref: #editing-uploading-downloading12374
+Ref: #editing-uploading-downloading12404
-Node: RELOADING13208
+Node: RELOADING13238
-Ref: #reloading13342
+Ref: #reloading13372
-Node: JSON API13775
+Node: JSON API13805
-Ref: #json-api13890
+Ref: #json-api13920
-Node: DEBUG OUTPUT19378
+Node: DEBUG OUTPUT19408
-Ref: #debug-output19503
+Ref: #debug-output19533
-Node: Debug output19530
+Node: Debug output19560
-Ref: #debug-output-119631
+Ref: #debug-output-119661
-Node: ENVIRONMENT20048
+Node: ENVIRONMENT20078
-Ref: #environment20167
+Ref: #environment20197
-Node: BUGS20284
+Node: BUGS20314
-Ref: #bugs20368
+Ref: #bugs20398
 
 End Tag Table
 

hledger-web/hledger-web.txt

@@ -2,7 +2,8 @@
 HLEDGER-WEB(1)               hledger User Manuals               HLEDGER-WEB(1)
 
 NAME
-       hledger-web - robust, friendly plain text accounting (Web version)
+       hledger-web  -  web  interface  and API for hledger, a robust, friendly
+       plain text accounting app.
 
 SYNOPSIS
        hledger-web    [--serve|--serve-api] [OPTS] [ARGS]

hledger/hledger.1

@@ -5,7 +5,8 @@
 
 
 .SH NAME
-hledger \- robust, friendly plain text accounting (CLI version)
+hledger \- a robust, friendly plain text accounting app (command line
+version).
 .SH SYNOPSIS
 \f[CR]hledger\f[R]
 .PD 0
@@ -7837,8 +7838,7 @@ Runs hledger\-ui (if installed).
 Runs hledger\-web (if installed).
 .SH Data entry commands
 .SS add
-Prompt for transactions and add them to the journal.
+Record new transactions with interactive prompting in the console.
-Any arguments will be used as default inputs for the first N prompts.
 .PP
 Many hledger users edit their journals directly with a text editor, or
 generate them from CSV.
@@ -7914,21 +7914,21 @@ Provide answers for the first four prompts:
 .PP
 There is a detailed tutorial at https://hledger.org/add.html.
 .SS import
-Read new transactions added to each FILE provided as arguments since
+Import new transactions from one or more data files to the main journal.
-last run, and add them to the journal.
+.PP
-Or with \-\-dry\-run, just print the transactions that would be added.
+This command detects new transactions in each FILE argument since it was
-Or with \-\-catchup, just mark all of the FILEs\[aq] current
+last run, and appends them to the main journal.
-transactions as imported, without importing them.
+.PP
+Or with \f[CR]\-\-dry\-run\f[R], it just print the transactions that
+would be added.
+.PP
+Or with \f[CR]\-\-catchup\f[R], it just marks all of the FILEs\[aq]
+current transactions as already imported.
 .PP
-This command may append new transactions to the main journal file (which
-should be in journal format).
-Existing transactions are not changed.
 This is one of the few hledger commands that writes to the journal file
 (see also \f[CR]add\f[R]).
+It only appends; existing data will not be changed.
 .PP
-Unlike other hledger commands, with \f[CR]import\f[R] the journal file
-is an output file, and will be modified, though only by appending
-(existing data will not be changed).
 The input files are specified as arguments, so to import one or more CSV
 files to your main journal, you will run
 \f[CR]hledger import bank.csv\f[R] or perhaps
@@ -7936,6 +7936,7 @@ files to your main journal, you will run
 .PP
 Note you can import from any file format, though CSV files are the most
 common import source, and these docs focus on that case.
+The target file (main journal) should be in journal format.
 .SS Date skipping
 \f[CR]import\f[R] tries to import only the transactions which are new
 since the last import, ignoring any that it has seen in previous runs.
@@ -8057,7 +8058,7 @@ amounts.
 Related: CSV > Amount decimal places.
 .SH Basic report commands
 .SS accounts
-Show account names.
+List account names.
 .PP
 This command lists account names.
 By default it shows all known accounts, either used in transactions or
@@ -8319,7 +8320,7 @@ also acquire tags from their account and transaction, transactions also
 acquire tags from their postings.
 .SH Standard report commands
 .SS print
-Show transaction journal entries, sorted by date.
+Show full journal entries, representing transactions.
 .PP
 The print command displays full journal entries (transactions) from the
 journal file, sorted by date (or with \f[CR]\-\-date2\f[R], by secondary
@@ -8511,8 +8512,8 @@ negative amounts under credit and zero or greater amounts under debit.)
 .SS aregister
 (areg)
 .PP
-Show the transactions and running historical balance of a single
+Show the transactions and running balances in one account, with each
-account, with each transaction displayed as one line.
+transaction on one line.
 .PP
 \f[CR]aregister\f[R] shows the overall transactions affecting a
 particular account (and any subaccounts).
@@ -8753,14 +8754,16 @@ options The output formats supported are \f[CR]txt\f[R], \f[CR]csv\f[R],
 .SS balancesheet
 (bs)
 .PP
-This command displays a balance sheet, showing historical ending
+Show the end balances in asset and liability accounts.
-balances of asset and liability accounts.
-(To see equity as well, use the balancesheetequity command.)
 Amounts are shown with normal positive sign, as in conventional
 financial statements.
 .PP
-This report shows accounts declared with the \f[CR]Asset\f[R],
+This command displays a balance sheet, showing historical ending
-\f[CR]Cash\f[R] or \f[CR]Liability\f[R] type (see account types).
+balances of asset and liability accounts.
+(To see equity as well, use the balancesheetequity command.)
+.PP
+Accounts declared with the \f[CR]Asset\f[R], \f[CR]Cash\f[R] or
+\f[CR]Liability\f[R] type are shown (see account types).
 Or if no such accounts are declared, it shows top\-level accounts named
 \f[CR]asset\f[R] or \f[CR]liability\f[R] (case insensitive, plurals
 allowed) and their subaccounts.
@@ -8916,12 +8919,14 @@ options The output formats supported are \f[CR]txt\f[R], \f[CR]csv\f[R],
 .SS incomestatement
 (is)
 .PP
-This command displays an income statement, showing revenues and expenses
+Show revenue inflows and expense outflows during the report period.
-during one or more periods.
 Amounts are shown with normal positive sign, as in conventional
 financial statements.
 .PP
-This report shows accounts declared with the \f[CR]Revenue\f[R] or
+This command displays an income statement, showing revenues and expenses
+during one or more periods.
+.PP
+It shows accounts declared with the \f[CR]Revenue\f[R] or
 \f[CR]Expense\f[R] type (see account types).
 Or if no such accounts are declared, it shows top\-level accounts named
 \f[CR]revenue\f[R] or \f[CR]income\f[R] or \f[CR]expense\f[R] (case
@@ -8968,7 +8973,10 @@ options The output formats supported are \f[CR]txt\f[R], \f[CR]csv\f[R],
 .SS balance
 (bal)
 .PP
-Show accounts and their balances.
+A flexible, general purpose \[dq]summing\[dq] report that shows accounts
+with some kind of numeric data.
+This can be balance changes per period, end balances, budget
+performance, unrealised capital gains, etc.
 .PP
 \f[CR]balance\f[R] is one of hledger\[aq]s oldest and most versatile
 commands, for listing account balances, balance changes, values, value

hledger/hledger.txt

@@ -2,7 +2,8 @@
 HLEDGER(1)                   hledger User Manuals                   HLEDGER(1)
 
 NAME
-       hledger - robust, friendly plain text accounting (CLI version)
+       hledger  -  a  robust, friendly plain text accounting app (command line
+       version).
 
 SYNOPSIS
        hledger
@@ -6061,8 +6062,7 @@ User interface commands
 
 Data entry commands
    add
-       Prompt for transactions and add them to  the  journal.   Any  arguments
+       Record new transactions with interactive prompting in the console.
-       will be used as default inputs for the first N prompts.
 
        Many  hledger users edit their journals directly with a text editor, or
        generate them from CSV.  For more interactive data entry, there is  the
@@ -6128,24 +6128,27 @@ Data entry commands
        There is a detailed tutorial at https://hledger.org/add.html.
 
    import
-       Read  new  transactions  added to each FILE provided as arguments since
+       Import  new  transactions from one or more data files to the main jour-
-       last run, and add them to the journal.  Or with --dry-run,  just  print
+       nal.
-       the transactions that would be added.  Or with --catchup, just mark all
-       of the FILEs' current transactions as imported, without importing them.
 
-       This  command  may  append  new  transactions  to the main journal file
+       This command detects new transactions in each FILE  argument  since  it
-       (which should be in journal format).   Existing  transactions  are  not
+       was last run, and appends them to the main journal.
-       changed.   This  is  one of the few hledger commands that writes to the
-       journal file (see also add).
 
-       Unlike other hledger commands, with import the journal file is an  out-
+       Or with --dry-run, it just print the transactions that would be added.
-       put file, and will be modified, though only by appending (existing data
+
-       will  not  be changed).  The input files are specified as arguments, so
+       Or with --catchup, it just marks all of the FILEs' current transactions
-       to import one or more CSV files to your  main  journal,  you  will  run
+       as already imported.
-       hledger import bank.csv or perhaps hledger import *.csv.
+
+       This is one of the few hledger commands that writes to the journal file
+       (see also add).  It only appends; existing data will not be changed.
+
+       The  input  files  are specified as arguments, so to import one or more
+       CSV files to your main journal, you will run hledger import bank.csv or
+       perhaps hledger import *.csv.
 
        Note you can import from any file format, though CSV files are the most
-       common import source, and these docs focus on that case.
+       common import source, and these docs focus on that  case.   The  target
+       file (main journal) should be in journal format.
 
    Date skipping
        import  tries  to  import only the transactions which are new since the
@@ -6255,7 +6258,7 @@ Data entry commands
 
 Basic report commands
    accounts
-       Show account names.
+       List account names.
 
        This command lists account names.  By default it shows  all  known  ac-
        counts,  either  used  in  transactions or declared with account direc-
@@ -6491,7 +6494,7 @@ Basic report commands
 
 Standard report commands
    print
-       Show transaction journal entries, sorted by date.
+       Show full journal entries, representing transactions.
 
        The print command displays full journal entries (transactions) from the
        journal file, sorted by date (or with --date2, by secondary date).
@@ -6668,8 +6671,8 @@ Standard report commands
    aregister
        (areg)
 
-       Show  the  transactions  and running historical balance of a single ac-
+       Show  the  transactions  and running balances in one account, with each
-       count, with each transaction displayed as one line.
+       transaction on one line.
 
        aregister shows the overall transactions affecting a particular account
        (and any subaccounts).  Each report line represents one transaction  in
@@ -6874,15 +6877,18 @@ Standard report commands
    balancesheet
        (bs)
 
+       Show  the  end  balances  in asset and liability accounts.  Amounts are
+       shown with normal positive sign, as in  conventional  financial  state-
+       ments.
+
        This  command  displays a balance sheet, showing historical ending bal-
        ances of asset and liability accounts.  (To see equity as well, use the
-       balancesheetequity command.)  Amounts are shown  with  normal  positive
+       balancesheetequity command.)
-       sign, as in conventional financial statements.
 
-       This  report  shows accounts declared with the Asset, Cash or Liability
+       Accounts declared with the Asset, Cash or Liability type are shown (see
-       type (see account types).  Or if no  such  accounts  are  declared,  it
+       account types).   Or  if  no  such  accounts  are  declared,  it  shows
-       shows  top-level  accounts  named asset or liability (case insensitive,
+       top-level  accounts named asset or liability (case insensitive, plurals
-       plurals allowed) and their subaccounts.
+       allowed) and their subaccounts.
 
        Example:
 
@@ -7018,14 +7024,17 @@ Standard report commands
    incomestatement
        (is)
 
-       This  command  displays  an  income statement, showing revenues and ex-
+       Show  revenue  inflows  and  expense outflows during the report period.
-       penses during one or more periods.  Amounts are shown with normal posi-
+       Amounts are shown with normal positive sign, as in conventional  finan-
-       tive sign, as in conventional financial statements.
+       cial statements.
 
-       This report shows accounts declared with the Revenue  or  Expense  type
+       This  command  displays  an  income statement, showing revenues and ex-
-       (see  account  types).   Or  if no such accounts are declared, it shows
+       penses during one or more periods.
-       top-level accounts named revenue or income or  expense  (case  insensi-
+
-       tive, plurals allowed) and their subaccounts.
+       It shows accounts declared with the Revenue or Expense  type  (see  ac-
+       count  types).  Or if no such accounts are declared, it shows top-level
+       accounts named revenue or income or expense (case insensitive,  plurals
+       allowed) and their subaccounts.
 
        Example:
 
@@ -7064,7 +7073,9 @@ Advanced report commands
    balance
        (bal)
 
-       Show accounts and their balances.
+       A flexible, general purpose "summing" report that shows  accounts  with
+       some kind of numeric data.  This can be balance changes per period, end
+       balances, budget performance, unrealised capital gains, etc.
 
        balance  is  one  of  hledger's oldest and most versatile commands, for
        listing account balances, balance changes, values,  value  changes  and