Skip to content

Commit

Permalink
;doc: update manuals
Browse files Browse the repository at this point in the history
  • Loading branch information
simonmichael committed Sep 5, 2024
1 parent 02d0209 commit 30c1eaf
Show file tree
Hide file tree
Showing 13 changed files with 1,765 additions and 1,609 deletions.
2 changes: 1 addition & 1 deletion hledger-lib/.date.m4
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
m4_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{June 2024}})m4_dnl
m4_define({{_monthyear_}}, {{September 2024}})m4_dnl
2 changes: 1 addition & 1 deletion hledger-ui/.date.m4
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
m4_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{June 2024}})m4_dnl
m4_define({{_monthyear_}}, {{September 2024}})m4_dnl
56 changes: 30 additions & 26 deletions hledger-ui/hledger-ui.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

.TH "HLEDGER\-UI" "1" "June 2024" "hledger-ui-1.34.99 " "hledger User Manuals"
.TH "HLEDGER\-UI" "1" "September 2024" "hledger-ui-1.40 " "hledger User Manuals"



Expand All @@ -17,7 +17,7 @@ or
.PD
\f[CR]hledger ui \-\- [OPTS] [QUERYARGS]\f[R]
.SH DESCRIPTION
This manual is for hledger\[aq]s terminal interface, version 1.34.99.
This manual is for hledger\[aq]s terminal interface, version 1.40.
See also the hledger manual for common concepts and file formats.
.PP
hledger is a robust, user\-friendly, cross\-platform set of programs for
Expand Down Expand Up @@ -178,31 +178,10 @@ Emacs\-style
(\f[CR]CTRL\-p\f[R]/\f[CR]CTRL\-n\f[R]/\f[CR]CTRL\-f\f[R]/\f[CR]CTRL\-b\f[R])
and VI\-style (\f[CR]k\f[R],\f[CR]j\f[R],\f[CR]l\f[R],\f[CR]h\f[R])
movement keys are also supported.
A tip: movement speed is limited by your keyboard repeat rate, to move
.PP
(Tip: movement speed is limited by your keyboard repeat rate, to move
faster you may want to adjust it.
(If you\[aq]re on a mac, the karabiner app is one way to do that.)
.PP
With shift pressed, the cursor keys adjust the report period, limiting
the transactions to be shown (by default, all are shown).
\f[CR]SHIFT\-DOWN/UP\f[R] steps downward and upward through these
standard report period durations: year, quarter, month, week, day.
Then, \f[CR]SHIFT\-LEFT/RIGHT\f[R] moves to the previous/next period.
\f[CR]T\f[R] sets the report period to today.
With the \f[CR]\-w/\-\-watch\f[R] option, when viewing a
\[dq]current\[dq] period (the current day, week, month, quarter, or
year), the period will move automatically to track the current date.
To set a non\-standard period, you can use \f[CR]/\f[R] and a
\f[CR]date:\f[R] query.
.PP
(Mac users: SHIFT\-DOWN/UP keys do not work by default in Terminal, as
of MacOS Monterey.
You can configure them as follows: open Terminal, press CMD\-comma to
open preferences, click Profiles, select your current terminal profile
on the left, click Keyboard on the right, click + and add this for
Shift\-Down: \f[CR]\[rs]033[1;2B\f[R], click + and add this for
Shift\-Up: \f[CR]\[rs]033[1;2A\f[R].
Press the Escape key to enter the \f[CR]\[rs]033\f[R] part, you
can\[aq]t type it directly.)
On a mac, the Karabiner app is one way to do that.)
.PP
\f[CR]/\f[R] lets you set a general filter query limiting the data
shown, using the same query terms as in hledger and hledger\-web.
Expand All @@ -219,6 +198,31 @@ transactions generated by rule.
\f[CR]F\f[R] toggles forecast mode, in which future/forecasted
transactions are shown.
.PP
Pressing \f[CR]SHIFT\-DOWN\f[R] narrows the report period, and pressing
\f[CR]SHIFT\-UP\f[R] expands it again.
When narrowed, the current report period is displayed in the header
line, pressing \f[CR]SHIFT\-LEFT\f[R] or \f[CR]SHIFT\-RIGHT\f[R] moves
to the previous or next period, and pressing \f[CR]T\f[R] sets the
period to \[dq]today\[dq].
If you are using \f[CR]\-w/\-\-watch\f[R] and viewing a narrowed period
containing today, the view will follow any changes in system date
(moving to the period containing the new date).
.PP
You can also specify a non\-standard period with \f[CR]/\f[R] and a
\f[CR]date:\f[R] query; in this case, the period is not movable with the
arrow keys.
.PP
(Tip: arrow keys with Shift do not work out of the box in all terminal
software.
Eg in Apple\[aq]s Terminal, the SHIFT\-DOWN and SHIFT\-UP keys must be
configured as follows: in Terminal\[aq]s preferences, click Profiles,
select your current profile on the left, click Keyboard on the right,
click + and add this for SHIFT\-DOWN: \f[CR]\[rs]033[1;2B\f[R], click +
and add this for SHIFT\-UP: \f[CR]\[rs]033[1;2A\f[R].
\ In other terminals (Windows Terminal ?)
you might need to configure SHIFT\-RIGHT and SHIFT\-LEFT to emit
\f[CR]\[rs]033[1;2C\f[R] and \f[CR]\[rs]033[1;2D\f[R] respectively.)
.PP
\f[CR]ESCAPE\f[R] resets the UI state and jumps back to the top screen,
restoring the app\[aq]s initial state at startup.
Or, it cancels minibuffer data entry or the help dialog.
Expand Down
110 changes: 57 additions & 53 deletions hledger-ui/hledger-ui.info
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ plain text accounting app.
or
'hledger ui -- [OPTS] [QUERYARGS]'

This manual is for hledger's terminal interface, version 1.34.99.
See also the hledger manual for common concepts and file formats.
This manual is for hledger's terminal interface, version 1.40. See
also the hledger manual for common concepts and file formats.

hledger is a robust, user-friendly, cross-platform set of programs
for tracking money, time, or any other commodity, using double-entry
Expand Down Expand Up @@ -192,27 +192,11 @@ most screens:
returns to the previous screen, 'UP'/'DOWN'/'PGUP'/'PGDN'/'HOME'/'END'
move up and down through lists. Emacs-style
('CTRL-p'/'CTRL-n'/'CTRL-f'/'CTRL-b') and VI-style ('k','j','l','h')
movement keys are also supported. A tip: movement speed is limited by
your keyboard repeat rate, to move faster you may want to adjust it.
(If you're on a mac, the karabiner app is one way to do that.)

With shift pressed, the cursor keys adjust the report period,
limiting the transactions to be shown (by default, all are shown).
'SHIFT-DOWN/UP' steps downward and upward through these standard report
period durations: year, quarter, month, week, day. Then,
'SHIFT-LEFT/RIGHT' moves to the previous/next period. 'T' sets the
report period to today. With the '-w/--watch' option, when viewing a
"current" period (the current day, week, month, quarter, or year), the
period will move automatically to track the current date. To set a
non-standard period, you can use '/' and a 'date:' query.

(Mac users: SHIFT-DOWN/UP keys do not work by default in Terminal, as
of MacOS Monterey. You can configure them as follows: open Terminal,
press CMD-comma to open preferences, click Profiles, select your current
terminal profile on the left, click Keyboard on the right, click + and
add this for Shift-Down: '\033[1;2B', click + and add this for Shift-Up:
'\033[1;2A'. Press the Escape key to enter the '\033' part, you can't
type it directly.)
movement keys are also supported.

(Tip: movement speed is limited by your keyboard repeat rate, to move
faster you may want to adjust it. On a mac, the Karabiner app is one
way to do that.)

'/' lets you set a general filter query limiting the data shown,
using the same query terms as in hledger and hledger-web. While editing
Expand All @@ -227,6 +211,26 @@ both ordinary transactions recorded in the journal, and periodic
transactions generated by rule. 'F' toggles forecast mode, in which
future/forecasted transactions are shown.

Pressing 'SHIFT-DOWN' narrows the report period, and pressing
'SHIFT-UP' expands it again. When narrowed, the current report period
is displayed in the header line, pressing 'SHIFT-LEFT' or 'SHIFT-RIGHT'
moves to the previous or next period, and pressing 'T' sets the period
to "today". If you are using '-w/--watch' and viewing a narrowed period
containing today, the view will follow any changes in system date
(moving to the period containing the new date).

You can also specify a non-standard period with '/' and a 'date:'
query; in this case, the period is not movable with the arrow keys.

(Tip: arrow keys with Shift do not work out of the box in all
terminal software. Eg in Apple's Terminal, the SHIFT-DOWN and SHIFT-UP
keys must be configured as follows: in Terminal's preferences, click
Profiles, select your current profile on the left, click Keyboard on the
right, click + and add this for SHIFT-DOWN: '\033[1;2B', click + and add
this for SHIFT-UP: '\033[1;2A'. In other terminals (Windows Terminal ?)
you might need to configure SHIFT-RIGHT and SHIFT-LEFT to emit
'\033[1;2C' and '\033[1;2D' respectively.)

'ESCAPE' resets the UI state and jumps back to the top screen,
restoring the app's initial state at startup. Or, it cancels minibuffer
data entry or the help dialog.
Expand Down Expand Up @@ -531,36 +535,36 @@ above).

Tag Table:
Node: Top221
Node: OPTIONS1872
Ref: #options1970
Node: MOUSE8236
Ref: #mouse8331
Node: KEYS8568
Ref: #keys8661
Node: SCREENS13316
Ref: #screens13420
Node: Menu screen14056
Ref: #menu-screen14177
Node: Cash accounts screen14372
Ref: #cash-accounts-screen14549
Node: Balance sheet accounts screen14733
Ref: #balance-sheet-accounts-screen14949
Node: Income statement accounts screen15069
Ref: #income-statement-accounts-screen15290
Node: All accounts screen15454
Ref: #all-accounts-screen15635
Node: Register screen15817
Ref: #register-screen15976
Node: Transaction screen18260
Ref: #transaction-screen18418
Node: Error screen19835
Ref: #error-screen19957
Node: WATCH MODE20201
Ref: #watch-mode20318
Node: ENVIRONMENT21777
Ref: #environment21893
Node: BUGS22084
Ref: #bugs22167
Node: OPTIONS1870
Ref: #options1968
Node: MOUSE8234
Ref: #mouse8329
Node: KEYS8566
Ref: #keys8659
Node: SCREENS13394
Ref: #screens13498
Node: Menu screen14134
Ref: #menu-screen14255
Node: Cash accounts screen14450
Ref: #cash-accounts-screen14627
Node: Balance sheet accounts screen14811
Ref: #balance-sheet-accounts-screen15027
Node: Income statement accounts screen15147
Ref: #income-statement-accounts-screen15368
Node: All accounts screen15532
Ref: #all-accounts-screen15713
Node: Register screen15895
Ref: #register-screen16054
Node: Transaction screen18338
Ref: #transaction-screen18496
Node: Error screen19913
Ref: #error-screen20035
Node: WATCH MODE20279
Ref: #watch-mode20396
Node: ENVIRONMENT21855
Ref: #environment21971
Node: BUGS22162
Ref: #bugs22245

End Tag Table

Expand Down
Loading

0 comments on commit 30c1eaf

Please sign in to comment.