slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc: update manuals

Browse Source
This commit is contained in:
Simon Michael 2022-10-01 16:09:26 -10:00
parent ae8d297396
commit 928cc6d615
13 changed files with 847 additions and 684 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hledger-lib/.date.m4
View File

@ -1,2 +1,2 @@
m4_dnl Date to show in man pages. Updated by "Shake manuals" m4_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{September 2022}})m4_dnl m4_define({{_monthyear_}}, {{October 2022}})m4_dnl

2
hledger-ui/.date.m4
View File

@ -1,2 +1,2 @@
m4_dnl Date to show in man pages. Updated by "Shake manuals" m4_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{September 2022}})m4_dnl m4_define({{_monthyear_}}, {{October 2022}})m4_dnl

28
hledger-ui/hledger-ui.1
View File

@ -1,5 +1,5 @@
.TH "HLEDGER-UI" "1" "September 2022" "hledger-ui-1.27 " "hledger User Manuals" .TH "HLEDGER-UI" "1" "October 2022" "hledger-ui-1.27.99 " "hledger User Manuals"
@ -7,7 +7,7 @@
.PP .PP
hledger-ui is a terminal interface (TUI) for the hledger accounting hledger-ui is a terminal interface (TUI) for the hledger accounting
tool. tool.
This manual is for hledger-ui 1.27. This manual is for hledger-ui 1.27.99.
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\f[C]hledger-ui [OPTIONS] [QUERYARGS]\f[R] \f[C]hledger-ui [OPTIONS] [QUERYARGS]\f[R]
@ -335,6 +335,10 @@ reliably reset to normal mode.
.PP .PP
Additional screen-specific keys are described below. Additional screen-specific keys are described below.
.SH SCREENS .SH SCREENS
.SS Menu screen
.PP
The top-most screen, currently with just one menu item and not shown by
default.
.SS Accounts screen .SS Accounts screen
.PP .PP
This is normally the first screen displayed. This is normally the first screen displayed.
@ -389,6 +393,7 @@ balances are shown (hledger-ui shows zero items by default, unlike
command-line hledger). command-line hledger).
.PP .PP
Press \f[C]RIGHT\f[R] to view an account\[aq]s transactions register. Press \f[C]RIGHT\f[R] to view an account\[aq]s transactions register.
Or, \f[C]LEFT\f[R] to see the menu screen.
.SS Register screen .SS Register screen
.PP .PP
This screen shows the transactions affecting a particular account, like This screen shows the transactions affecting a particular account, like
@ -455,6 +460,25 @@ They will vary depending on which account register you came from
The #N number preceding them is the transaction\[aq]s position within The #N number preceding them is the transaction\[aq]s position within
the complete unfiltered journal, which is a more stable id (at least the complete unfiltered journal, which is a more stable id (at least
until the next reload). until the next reload).
.SS Balance sheet accounts screen
.PP
This is like the accounts screen except:
.IP \[bu] 2
it shows only asset, liability and equity accounts (see account types)
.IP \[bu] 2
it always shows historical end balances on some date (not balance
changes).
.PP
It corresponds to the \f[C]hledger balancesheet\f[R] command.
.SS Income statement accounts screen
.PP
Like the accounts screen except:
.IP \[bu] 2
it shows only revenue and expense accounts
.IP \[bu] 2
it always shows balance changes in some period (not end balances).
.PP
It corresponds to the \f[C]hledger incomestatement\f[R] command.
.SS Error screen .SS Error screen
.PP .PP
This screen will appear if there is a problem, such as a parse error, This screen will appear if there is a problem, such as a parse error,

121
hledger-ui/hledger-ui.info
View File

@ -12,7 +12,7 @@ hledger-ui(1)
************* *************
hledger-ui is a terminal interface (TUI) for the hledger accounting hledger-ui is a terminal interface (TUI) for the hledger accounting
tool. This manual is for hledger-ui 1.27. tool. This manual is for hledger-ui 1.27.99.
'hledger-ui [OPTIONS] [QUERYARGS]' 'hledger-ui [OPTIONS] [QUERYARGS]'
'hledger ui -- [OPTIONS] [QUERYARGS]' 'hledger ui -- [OPTIONS] [QUERYARGS]'
@ -354,15 +354,27 @@ File: hledger-ui.info, Node: SCREENS, Next: TIPS, Prev: KEYS, Up: Top
* Menu: * Menu:
* Menu screen::
* Accounts screen:: * Accounts screen::
* Register screen:: * Register screen::
* Transaction screen:: * Transaction screen::
* Balance sheet accounts screen::
* Income statement accounts screen::
* Error screen:: * Error screen::
 
File: hledger-ui.info, Node: Accounts screen, Next: Register screen, Up: SCREENS File: hledger-ui.info, Node: Menu screen, Next: Accounts screen, Up: SCREENS
4.1 Accounts screen 4.1 Menu screen
===============
The top-most screen, currently with just one menu item and not shown by
default.

File: hledger-ui.info, Node: Accounts screen, Next: Register screen, Prev: Menu screen, Up: SCREENS
4.2 Accounts screen
=================== ===================
This is normally the first screen displayed. It lists accounts and This is normally the first screen displayed. It lists accounts and
@ -408,12 +420,13 @@ is removed.)
balances are shown (hledger-ui shows zero items by default, unlike balances are shown (hledger-ui shows zero items by default, unlike
command-line hledger). command-line hledger).
Press 'RIGHT' to view an account's transactions register. Press 'RIGHT' to view an account's transactions register. Or, 'LEFT'
to see the menu screen.
 
File: hledger-ui.info, Node: Register screen, Next: Transaction screen, Prev: Accounts screen, Up: SCREENS File: hledger-ui.info, Node: Register screen, Next: Transaction screen, Prev: Accounts screen, Up: SCREENS
4.2 Register screen 4.3 Register screen
=================== ===================
This screen shows the transactions affecting a particular account, like This screen shows the transactions affecting a particular account, like
@ -457,9 +470,9 @@ command-line hledger).
Press 'RIGHT' to view the selected transaction in detail. Press 'RIGHT' to view the selected transaction in detail.
 
File: hledger-ui.info, Node: Transaction screen, Next: Error screen, Prev: Register screen, Up: SCREENS File: hledger-ui.info, Node: Transaction screen, Next: Balance sheet accounts screen, Prev: Register screen, Up: SCREENS
4.3 Transaction screen 4.4 Transaction screen
====================== ======================
This screen shows a single transaction, as a general journal entry, This screen shows a single transaction, as a general journal entry,
@ -481,9 +494,37 @@ unfiltered journal, which is a more stable id (at least until the next
reload). reload).
 
File: hledger-ui.info, Node: Error screen, Prev: Transaction screen, Up: SCREENS File: hledger-ui.info, Node: Balance sheet accounts screen, Next: Income statement accounts screen, Prev: Transaction screen, Up: SCREENS
4.4 Error screen 4.5 Balance sheet accounts screen
=================================
This is like the accounts screen except:
* it shows only asset, liability and equity accounts (see account
types)
* it always shows historical end balances on some date (not balance
changes).
It corresponds to the 'hledger balancesheet' command.

File: hledger-ui.info, Node: Income statement accounts screen, Next: Error screen, Prev: Balance sheet accounts screen, Up: SCREENS
4.6 Income statement accounts screen
====================================
Like the accounts screen except:
* it shows only revenue and expense accounts
* it always shows balance changes in some period (not end balances).
It corresponds to the 'hledger incomestatement' command.

File: hledger-ui.info, Node: Error screen, Prev: Income statement accounts screen, Up: SCREENS
4.7 Error screen
================ ================
This screen will appear if there is a problem, such as a parse error, This screen will appear if there is a problem, such as a parse error,
@ -640,34 +681,40 @@ program is restarted.
 
Tag Table: Tag Table:
Node: Top221 Node: Top221
Node: OPTIONS1654 Node: OPTIONS1657
Ref: #options1752 Ref: #options1755
Node: MOUSE6634 Node: MOUSE6637
Ref: #mouse6729 Ref: #mouse6732
Node: KEYS7011 Node: KEYS7014
Ref: #keys7104 Ref: #keys7107
Node: SCREENS11190 Node: SCREENS11193
Ref: #screens11288 Ref: #screens11291
Node: Accounts screen11378 Node: Menu screen11468
Ref: #accounts-screen11506 Ref: #menu-screen11584
Node: Register screen13845 Node: Accounts screen11666
Ref: #register-screen14000 Ref: #accounts-screen11814
Node: Transaction screen15984 Node: Register screen14189
Ref: #transaction-screen16142 Ref: #register-screen14344
Node: Error screen17012 Node: Transaction screen16328
Ref: #error-screen17134 Ref: #transaction-screen16503
Node: TIPS17378 Node: Balance sheet accounts screen17373
Ref: #tips17477 Ref: #balance-sheet-accounts-screen17587
Node: Watch mode17529 Node: Income statement accounts screen17855
Ref: #watch-mode17646 Ref: #income-statement-accounts-screen18069
Node: Watch mode limitations18396 Node: Error screen18285
Ref: #watch-mode-limitations18537 Ref: #error-screen18421
Node: ENVIRONMENT19673 Node: TIPS18665
Ref: #environment19784 Ref: #tips18764
Node: FILES21169 Node: Watch mode18816
Ref: #files21268 Ref: #watch-mode18933
Node: BUGS21481 Node: Watch mode limitations19683
Ref: #bugs21558 Ref: #watch-mode-limitations19824
Node: ENVIRONMENT20960
Ref: #environment21071
Node: FILES22456
Ref: #files22555
Node: BUGS22768
Ref: #bugs22845
 
End Tag Table End Tag Table

77
hledger-ui/hledger-ui.txt
View File

@ -5,7 +5,7 @@ HLEDGER-UI(1) hledger User Manuals HLEDGER-UI(1)
NAME NAME
hledger-ui is a terminal interface (TUI) for the hledger accounting hledger-ui is a terminal interface (TUI) for the hledger accounting
tool. This manual is for hledger-ui 1.27. tool. This manual is for hledger-ui 1.27.99.
SYNOPSIS SYNOPSIS
hledger-ui [OPTIONS] [QUERYARGS] hledger-ui [OPTIONS] [QUERYARGS]
@ -308,50 +308,55 @@ KEYS
Additional screen-specific keys are described below. Additional screen-specific keys are described below.
SCREENS SCREENS
Menu screen
The top-most screen, currently with just one menu item and not shown by
default.
Accounts screen Accounts screen
This is normally the first screen displayed. It lists accounts and This is normally the first screen displayed. It lists accounts and
their balances, like hledger's balance command. By default, it shows their balances, like hledger's balance command. By default, it shows
all accounts and their latest ending balances (including the balances all accounts and their latest ending balances (including the balances
of subaccounts). Accounts which have been declared with an account of subaccounts). Accounts which have been declared with an account
directive are also listed, even if not yet used (except for empty par- directive are also listed, even if not yet used (except for empty par-
ent accounts). If you specify a query on the command line, it shows ent accounts). If you specify a query on the command line, it shows
just the matched accounts and the balances from matched transactions. just the matched accounts and the balances from matched transactions.
Account names are shown as a flat list by default; press t to toggle Account names are shown as a flat list by default; press t to toggle
tree mode. In list mode, account balances are exclusive of subac- tree mode. In list mode, account balances are exclusive of subac-
counts, except where subaccounts are hidden by a depth limit (see counts, except where subaccounts are hidden by a depth limit (see
below). In tree mode, all account balances are inclusive of subac- below). In tree mode, all account balances are inclusive of subac-
counts. counts.
To see less detail, press a number key, 1 to 9, to set a depth limit. To see less detail, press a number key, 1 to 9, to set a depth limit.
Or use - to decrease and +/= to increase the depth limit. 0 shows even Or use - to decrease and +/= to increase the depth limit. 0 shows even
less detail, collapsing all accounts to a single total. To remove the less detail, collapsing all accounts to a single total. To remove the
depth limit, set it higher than the maximum account depth, or press depth limit, set it higher than the maximum account depth, or press
ESCAPE. ESCAPE.
H toggles between showing historical balances or period balances. His- H toggles between showing historical balances or period balances. His-
torical balances (the default) are ending balances at the end of the torical balances (the default) are ending balances at the end of the
report period, taking into account all transactions before that date report period, taking into account all transactions before that date
(filtered by the filter query if any), including transactions before (filtered by the filter query if any), including transactions before
the start of the report period. In other words, historical balances the start of the report period. In other words, historical balances
are what you would see on a bank statement for that account (unless are what you would see on a bank statement for that account (unless
disturbed by a filter query). Period balances ignore transactions disturbed by a filter query). Period balances ignore transactions
before the report start date, so they show the change in balance during before the report start date, so they show the change in balance during
the report period. They are more useful eg when viewing a time log. the report period. They are more useful eg when viewing a time log.
U toggles filtering by unmarked status, including or excluding unmarked U toggles filtering by unmarked status, including or excluding unmarked
postings in the balances. Similarly, P toggles pending postings, and C postings in the balances. Similarly, P toggles pending postings, and C
toggles cleared postings. (By default, balances include all postings; toggles cleared postings. (By default, balances include all postings;
if you activate one or two status filters, only those postings are if you activate one or two status filters, only those postings are
included; and if you activate all three, the filter is removed.) included; and if you activate all three, the filter is removed.)
R toggles real mode, in which virtual postings are ignored. R toggles real mode, in which virtual postings are ignored.
z toggles nonzero mode, in which only accounts with nonzero balances z toggles nonzero mode, in which only accounts with nonzero balances
are shown (hledger-ui shows zero items by default, unlike command-line are shown (hledger-ui shows zero items by default, unlike command-line
hledger). hledger).
Press RIGHT to view an account's transactions register. Press RIGHT to view an account's transactions register. Or, LEFT to
see the menu screen.
Register screen Register screen
This screen shows the transactions affecting a particular account, like This screen shows the transactions affecting a particular account, like
@ -411,6 +416,26 @@ SCREENS
them is the transaction's position within the complete unfiltered jour- them is the transaction's position within the complete unfiltered jour-
nal, which is a more stable id (at least until the next reload). nal, which is a more stable id (at least until the next reload).
Balance sheet accounts screen
This is like the accounts screen except:
o it shows only asset, liability and equity accounts (see account
types)
o it always shows historical end balances on some date (not balance
changes).
It corresponds to the hledger balancesheet command.
Income statement accounts screen
Like the accounts screen except:
o it shows only revenue and expense accounts
o it always shows balance changes in some period (not end balances).
It corresponds to the hledger incomestatement command.
Error screen Error screen
This screen will appear if there is a problem, such as a parse error, This screen will appear if there is a problem, such as a parse error,
when you press g to reload. Once you have fixed the problem, press g when you press g to reload. Once you have fixed the problem, press g
@ -549,4 +574,4 @@ SEE ALSO
hledger-ui-1.27 September 2022 HLEDGER-UI(1) hledger-ui-1.27.99 October 2022 HLEDGER-UI(1)

2
hledger-web/.date.m4
View File

@ -1,2 +1,2 @@
m4_dnl Date to show in man pages. Updated by "Shake manuals" m4_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{September 2022}})m4_dnl m4_define({{_monthyear_}}, {{October 2022}})m4_dnl

4
hledger-web/hledger-web.1
View File

@ -1,12 +1,12 @@
.TH "HLEDGER-WEB" "1" "September 2022" "hledger-web-1.27 " "hledger User Manuals" .TH "HLEDGER-WEB" "1" "October 2022" "hledger-web-1.27.99 " "hledger User Manuals"
.SH NAME .SH NAME
.PP .PP
hledger-web is a web interface (WUI) for the hledger accounting tool. hledger-web is a web interface (WUI) for the hledger accounting tool.
This manual is for hledger-web 1.27. This manual is for hledger-web 1.27.99.
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\f[C]hledger-web [OPTIONS]\f[R] \f[C]hledger-web [OPTIONS]\f[R]

34
hledger-web/hledger-web.info
View File

@ -12,7 +12,7 @@ hledger-web(1)
************** **************
hledger-web is a web interface (WUI) for the hledger accounting tool. hledger-web is a web interface (WUI) for the hledger accounting tool.
This manual is for hledger-web 1.27. This manual is for hledger-web 1.27.99.
'hledger-web [OPTIONS]' 'hledger-web [OPTIONS]'
'hledger web -- [OPTIONS]' 'hledger web -- [OPTIONS]'
@ -632,22 +632,22 @@ awkward.
 
Tag Table: Tag Table:
Node: Top223 Node: Top223
Node: OPTIONS1886 Node: OPTIONS1889
Ref: #options1991 Ref: #options1994
Node: PERMISSIONS9902 Node: PERMISSIONS9905
Ref: #permissions10041 Ref: #permissions10044
Node: EDITING UPLOADING DOWNLOADING11253 Node: EDITING UPLOADING DOWNLOADING11256
Ref: #editing-uploading-downloading11434 Ref: #editing-uploading-downloading11437
Node: RELOADING12268 Node: RELOADING12271
Ref: #reloading12402 Ref: #reloading12405
Node: JSON API12835 Node: JSON API12838
Ref: #json-api12949 Ref: #json-api12952
Node: ENVIRONMENT18439 Node: ENVIRONMENT18442
Ref: #environment18555 Ref: #environment18558
Node: FILES19866 Node: FILES19869
Ref: #files19966 Ref: #files19969
Node: BUGS20179 Node: BUGS20182
Ref: #bugs20257 Ref: #bugs20260
 
End Tag Table End Tag Table

4
hledger-web/hledger-web.txt
View File

@ -5,7 +5,7 @@ HLEDGER-WEB(1) hledger User Manuals HLEDGER-WEB(1)
NAME NAME
hledger-web is a web interface (WUI) for the hledger accounting tool. hledger-web is a web interface (WUI) for the hledger accounting tool.
This manual is for hledger-web 1.27. This manual is for hledger-web 1.27.99.
SYNOPSIS SYNOPSIS
hledger-web [OPTIONS] hledger-web [OPTIONS]
@ -586,4 +586,4 @@ SEE ALSO
hledger-web-1.27 September 2022 HLEDGER-WEB(1) hledger-web-1.27.99 October 2022 HLEDGER-WEB(1)

2
hledger/.date.m4
View File

@ -1,2 +1,2 @@
m4_dnl Date to show in man pages. Updated by "Shake manuals" m4_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{September 2022}})m4_dnl m4_define({{_monthyear_}}, {{October 2022}})m4_dnl

54
hledger/hledger.1
View File

@ -1,6 +1,6 @@
.\"t .\"t
.TH "HLEDGER" "1" "September 2022" "hledger-1.27 " "hledger User Manuals" .TH "HLEDGER" "1" "October 2022" "hledger-1.27.99 " "hledger User Manuals"
@ -9,7 +9,7 @@
This is the command-line interface (CLI) for the hledger accounting This is the command-line interface (CLI) for the hledger accounting
tool. tool.
Here we also describe hledger\[aq]s concepts and file formats. Here we also describe hledger\[aq]s concepts and file formats.
This manual is for hledger 1.27. This manual is for hledger 1.27.99.
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\f[C]hledger\f[R] \f[C]hledger\f[R]
@ -3281,7 +3281,7 @@ backward.
Input prompts are displayed in a different colour when the terminal Input prompts are displayed in a different colour when the terminal
supports it. supports it.
.PP .PP
Example (see the tutorial for a detailed explanation): Example (see https://hledger.org/add.html for a detailed tutorial):
.IP .IP
.nf .nf
\f[C] \f[C]
@ -9781,8 +9781,10 @@ date-format DATEFMT
This is a helper for the \f[C]date\f[R] (and \f[C]date2\f[R]) fields. This is a helper for the \f[C]date\f[R] (and \f[C]date2\f[R]) fields.
If your CSV dates are not formatted like \f[C]YYYY-MM-DD\f[R], If your CSV dates are not formatted like \f[C]YYYY-MM-DD\f[R],
\f[C]YYYY/MM/DD\f[R] or \f[C]YYYY.MM.DD\f[R], you\[aq]ll need to add a \f[C]YYYY/MM/DD\f[R] or \f[C]YYYY.MM.DD\f[R], you\[aq]ll need to add a
date-format rule describing them with a strptime date parsing pattern, date-format rule describing them with a strptime-style date parsing
which must parse the CSV date value completely. pattern - see
https://hackage.haskell.org/package/time/docs/Data-Time-Format.html#v:formatTime.
The pattern must parse the CSV date value completely.
Some examples: Some examples:
.IP .IP
.nf .nf
@ -9814,17 +9816,41 @@ date-format %Y-%h-%d
date-format %-m/%-d/%Y %l:%M %p some other junk date-format %-m/%-d/%Y %l:%M %p some other junk
\f[R] \f[R]
.fi .fi
.SS \f[C]timezone\f[R]
.IP
.nf
\f[C]
timezone TIMEZONE
\f[R]
.fi
.PP .PP
For the supported strptime syntax, see: When CSV contains date-times that are implicitly in some time zone other
.PD 0 than yours, but containing no explicit time zone information, you can
.P use this rule to declare the CSV\[aq]s native time zone, which helps
.PD prevent off-by-one dates.
https://hackage.haskell.org/package/time/docs/Data-Time-Format.html#v:formatTime
.PP .PP
Note that although you can parse date-times which include a time zone, When the CSV date-times do contain time zone information, you don\[aq]t
that time zone is ignored; it will not change the date that is parsed. need this rule; instead, use \f[C]%Z\f[R] in \f[C]date-format\f[R] (or
This means when reading CSV data with times not in your local time zone, \f[C]%z\f[R], \f[C]%EZ\f[R], \f[C]%Ez\f[R]; see the formatTime link
dates can be \[dq]off by one\[dq]. above).
.PP
In either of these cases, hledger will do a time-zone-aware conversion,
localising the CSV date-times to your current system time zone.
If you prefer to localise to some other time zone, eg for
reproducibility, you can (on unix at least) set the output timezone with
the TZ environment variable, eg:
.IP
.nf
\f[C]
$ TZ=HST hledger print -f foo.csv # or TZ=HST hledger import foo.csv
\f[R]
.fi
.PP
\f[C]timezone\f[R] currently does not understand timezone names, except
\[dq]UTC\[dq], \[dq]GMT\[dq], \[dq]EST\[dq], \[dq]EDT\[dq],
\[dq]CST\[dq], \[dq]CDT\[dq], \[dq]MST\[dq], \[dq]MDT\[dq],
\[dq]PST\[dq], or \[dq]PDT\[dq].
For others, use numeric format: +HHMM or -HHMM.
.SS \f[C]decimal-mark\f[R] .SS \f[C]decimal-mark\f[R]
.IP .IP
.nf .nf

1159
hledger/hledger.info
View File

File diff suppressed because it is too large Load Diff

42
hledger/hledger.txt
View File

@ -6,7 +6,7 @@ HLEDGER(1) hledger User Manuals HLEDGER(1)
NAME NAME
This is the command-line interface (CLI) for the hledger accounting This is the command-line interface (CLI) for the hledger accounting
tool. Here we also describe hledger's concepts and file formats. This tool. Here we also describe hledger's concepts and file formats. This
manual is for hledger 1.27. manual is for hledger 1.27.99.
SYNOPSIS SYNOPSIS
hledger hledger
@ -2202,7 +2202,7 @@ COMMANDS
o Input prompts are displayed in a different colour when the terminal o Input prompts are displayed in a different colour when the terminal
supports it. supports it.
Example (see the tutorial for a detailed explanation): Example (see https://hledger.org/add.html for a detailed tutorial):
$ hledger add $ hledger add
Adding transactions to journal file /src/hledger/examples/sample.journal Adding transactions to journal file /src/hledger/examples/sample.journal
@ -7079,9 +7079,10 @@ CSV FORMAT
This is a helper for the date (and date2) fields. If your CSV dates This is a helper for the date (and date2) fields. If your CSV dates
are not formatted like YYYY-MM-DD, YYYY/MM/DD or YYYY.MM.DD, you'll are not formatted like YYYY-MM-DD, YYYY/MM/DD or YYYY.MM.DD, you'll
need to add a date-format rule describing them with a strptime date need to add a date-format rule describing them with a strptime-style
parsing pattern, which must parse the CSV date value completely. Some date parsing pattern - see https://hackage.haskell.org/pack-
examples: age/time/docs/Data-Time-Format.html#v:formatTime. The pattern must
parse the CSV date value completely. Some examples:
# MM/DD/YY # MM/DD/YY
date-format %m/%d/%y date-format %m/%d/%y
@ -7097,14 +7098,29 @@ CSV FORMAT
# Note the time and junk must be fully parsed, though only the date is used. # Note the time and junk must be fully parsed, though only the date is used.
date-format %-m/%-d/%Y %l:%M %p some other junk date-format %-m/%-d/%Y %l:%M %p some other junk
For the supported strptime syntax, see: timezone
https://hackage.haskell.org/package/time/docs/Data-Time-For- timezone TIMEZONE
mat.html#v:formatTime
Note that although you can parse date-times which include a time zone, When CSV contains date-times that are implicitly in some time zone
that time zone is ignored; it will not change the date that is parsed. other than yours, but containing no explicit time zone information, you
This means when reading CSV data with times not in your local time can use this rule to declare the CSV's native time zone, which helps
zone, dates can be "off by one". prevent off-by-one dates.
When the CSV date-times do contain time zone information, you don't
need this rule; instead, use %Z in date-format (or %z, %EZ, %Ez; see
the formatTime link above).
In either of these cases, hledger will do a time-zone-aware conversion,
localising the CSV date-times to your current system time zone. If you
prefer to localise to some other time zone, eg for reproducibility, you
can (on unix at least) set the output timezone with the TZ environment
variable, eg:
$ TZ=HST hledger print -f foo.csv # or TZ=HST hledger import foo.csv
timezone currently does not understand timezone names, except "UTC",
"GMT", "EST", "EDT", "CST", "CDT", "MST", "MDT", "PST", or "PDT". For
others, use numeric format: +HHMM or -HHMM.
decimal-mark decimal-mark
decimal-mark . decimal-mark .
@ -8155,4 +8171,4 @@ SEE ALSO
hledger-1.27 September 2022 HLEDGER(1) hledger-1.27.99 October 2022 HLEDGER(1)