;update manuals
This commit is contained in:
		
							parent
							
								
									9824c9683a
								
							
						
					
					
						commit
						8d320bc1fe
					
				| @ -5,7 +5,9 @@ | |||||||
| 
 | 
 | ||||||
| .SH NAME | .SH NAME | ||||||
| .PP | .PP | ||||||
| A terminal interface (TUI) for the hledger accounting tool. | hledger-ui is a terminal interface (TUI) for the hledger accounting | ||||||
|  | tool. | ||||||
|  | This manual is for hledger-ui 1.20.99. | ||||||
| .SH SYNOPSIS | .SH SYNOPSIS | ||||||
| .PP | .PP | ||||||
| \f[C]hledger-ui [OPTIONS] [QUERYARGS]\f[R] | \f[C]hledger-ui [OPTIONS] [QUERYARGS]\f[R] | ||||||
| @ -505,5 +507,3 @@ Released under GNU GPL v3 or later. | |||||||
| 
 | 
 | ||||||
| .SH SEE ALSO | .SH SEE ALSO | ||||||
| hledger(1), hledger\-ui(1), hledger\-web(1), ledger(1) | hledger(1), hledger\-ui(1), hledger\-web(1), ledger(1) | ||||||
| 
 |  | ||||||
| hledger_journal(5), hledger_csv(5), hledger_timeclock(5), hledger_timedot(5) |  | ||||||
|  | |||||||
| @ -6,7 +6,8 @@ File: hledger-ui.info,  Node: Top,  Next: OPTIONS,  Up: (dir) | |||||||
| hledger-ui(1) | hledger-ui(1) | ||||||
| ************* | ************* | ||||||
| 
 | 
 | ||||||
| A terminal interface (TUI) for the hledger accounting tool. | hledger-ui is a terminal interface (TUI) for the hledger accounting | ||||||
|  | tool.  This manual is for hledger-ui 1.20.99. | ||||||
| 
 | 
 | ||||||
|    'hledger-ui [OPTIONS] [QUERYARGS]' |    'hledger-ui [OPTIONS] [QUERYARGS]' | ||||||
| 'hledger ui -- [OPTIONS] [QUERYARGS]' | 'hledger ui -- [OPTIONS] [QUERYARGS]' | ||||||
| @ -519,25 +520,25 @@ program is restarted. | |||||||
|  |  | ||||||
| Tag Table: | Tag Table: | ||||||
| Node: Top71 | Node: Top71 | ||||||
| Node: OPTIONS1434 | Node: OPTIONS1488 | ||||||
| Ref: #options1531 | Ref: #options1585 | ||||||
| Node: KEYS5598 | Node: KEYS5652 | ||||||
| Ref: #keys5693 | Ref: #keys5747 | ||||||
| Node: SCREENS10012 | Node: SCREENS10066 | ||||||
| Ref: #screens10117 | Ref: #screens10171 | ||||||
| Node: Accounts screen10207 | Node: Accounts screen10261 | ||||||
| Ref: #accounts-screen10335 | Ref: #accounts-screen10389 | ||||||
| Node: Register screen12550 | Node: Register screen12604 | ||||||
| Ref: #register-screen12705 | Ref: #register-screen12759 | ||||||
| Node: Transaction screen14702 | Node: Transaction screen14756 | ||||||
| Ref: #transaction-screen14860 | Ref: #transaction-screen14914 | ||||||
| Node: Error screen15730 | Node: Error screen15784 | ||||||
| Ref: #error-screen15852 | Ref: #error-screen15906 | ||||||
| Node: ENVIRONMENT16096 | Node: ENVIRONMENT16150 | ||||||
| Ref: #environment16210 | Ref: #environment16264 | ||||||
| Node: FILES17017 | Node: FILES17071 | ||||||
| Ref: #files17116 | Ref: #files17170 | ||||||
| Node: BUGS17329 | Node: BUGS17383 | ||||||
| Ref: #bugs17406 | Ref: #bugs17460 | ||||||
|  |  | ||||||
| End Tag Table | End Tag Table | ||||||
|  | |||||||
| @ -4,40 +4,41 @@ HLEDGER-UI(1)                hledger User Manuals                HLEDGER-UI(1) | |||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| NAME | NAME | ||||||
|        A terminal interface (TUI) for the hledger accounting tool. |        hledger-ui  is  a  terminal  interface (TUI) for the hledger accounting | ||||||
|  |        tool.  This manual is for hledger-ui 1.20.99. | ||||||
| 
 | 
 | ||||||
| SYNOPSIS | SYNOPSIS | ||||||
|        hledger-ui [OPTIONS] [QUERYARGS] |        hledger-ui [OPTIONS] [QUERYARGS] | ||||||
|        hledger ui -- [OPTIONS] [QUERYARGS] |        hledger ui -- [OPTIONS] [QUERYARGS] | ||||||
| 
 | 
 | ||||||
| DESCRIPTION | DESCRIPTION | ||||||
|        hledger  is  a  reliable,  cross-platform  set of programs for tracking |        hledger is a reliable, cross-platform  set  of  programs  for  tracking | ||||||
|        money, time, or any other commodity, using double-entry accounting  and |        money,  time, or any other commodity, using double-entry accounting and | ||||||
|        a  simple,  editable  file  format.  hledger is inspired by and largely |        a simple, editable file format.  hledger is  inspired  by  and  largely | ||||||
|        compatible with ledger(1). |        compatible with ledger(1). | ||||||
| 
 | 
 | ||||||
|        hledger-ui is hledger's  terminal  interface,  providing  an  efficient |        hledger-ui  is  hledger's  terminal  interface,  providing an efficient | ||||||
|        full-window  text  UI  for  viewing accounts and transactions, and some |        full-window text UI for viewing accounts  and  transactions,  and  some | ||||||
|        limited data entry capability.  It is easier  than  hledger's  command- |        limited  data  entry  capability.  It is easier than hledger's command- | ||||||
|        line  interface, and sometimes quicker and more convenient than the web |        line interface, and sometimes quicker and more convenient than the  web | ||||||
|        interface. |        interface. | ||||||
| 
 | 
 | ||||||
|        Like hledger, it reads data from one or more files in hledger  journal, |        Like  hledger, it reads data from one or more files in hledger journal, | ||||||
|        timeclock,  timedot,  or CSV format specified with -f, or $LEDGER_FILE, |        timeclock, timedot, or CSV format specified with -f,  or  $LEDGER_FILE, | ||||||
|        or       $HOME/.hledger.journal       (on       windows,        perhaps |        or        $HOME/.hledger.journal       (on       windows,       perhaps | ||||||
|        C:/Users/USER/.hledger.journal).   For  more about this see hledger(1), |        C:/Users/USER/.hledger.journal).  For more about this  see  hledger(1), | ||||||
|        hledger_journal(5) etc. |        hledger_journal(5) etc. | ||||||
| 
 | 
 | ||||||
|        Unlike hledger, hledger-ui hides all future-dated transactions  by  de- |        Unlike  hledger,  hledger-ui hides all future-dated transactions by de- | ||||||
|        fault.   They  can  be revealed, along with any rule-generated periodic |        fault.  They can be revealed, along with  any  rule-generated  periodic | ||||||
|        transactions, by pressing the F key (or starting  with  --forecast)  to |        transactions,  by  pressing  the F key (or starting with --forecast) to | ||||||
|        enable "forecast mode". |        enable "forecast mode". | ||||||
| 
 | 
 | ||||||
| OPTIONS | OPTIONS | ||||||
|        Note:  if  invoking hledger-ui as a hledger subcommand, write -- before |        Note: if invoking hledger-ui as a hledger subcommand, write  --  before | ||||||
|        options as shown above. |        options as shown above. | ||||||
| 
 | 
 | ||||||
|        Any QUERYARGS are interpreted as a hledger search query  which  filters |        Any  QUERYARGS  are interpreted as a hledger search query which filters | ||||||
|        the data. |        the data. | ||||||
| 
 | 
 | ||||||
|        --watch |        --watch | ||||||
| @ -50,7 +51,7 @@ OPTIONS | |||||||
|               start in the (first) matched account's register screen |               start in the (first) matched account's register screen | ||||||
| 
 | 
 | ||||||
|        --change |        --change | ||||||
|               show  period balances (changes) at startup instead of historical |               show period balances (changes) at startup instead of  historical | ||||||
|               balances |               balances | ||||||
| 
 | 
 | ||||||
|        -l --flat |        -l --flat | ||||||
| @ -66,7 +67,7 @@ OPTIONS | |||||||
|               $LEDGER_FILE or $HOME/.hledger.journal) |               $LEDGER_FILE or $HOME/.hledger.journal) | ||||||
| 
 | 
 | ||||||
|        --rules-file=RULESFILE |        --rules-file=RULESFILE | ||||||
|               Conversion   rules  file  to  use  when  reading  CSV  (default: |               Conversion  rules  file  to  use  when  reading  CSV   (default: | ||||||
|               FILE.rules) |               FILE.rules) | ||||||
| 
 | 
 | ||||||
|        --separator=CHAR |        --separator=CHAR | ||||||
| @ -85,7 +86,7 @@ OPTIONS | |||||||
|               assignments) |               assignments) | ||||||
| 
 | 
 | ||||||
|        -s --strict |        -s --strict | ||||||
|               do  extra error checking (check that all posted accounts are de- |               do extra error checking (check that all posted accounts are  de- | ||||||
|               clared) |               clared) | ||||||
| 
 | 
 | ||||||
|        hledger reporting options: |        hledger reporting options: | ||||||
| @ -112,7 +113,7 @@ OPTIONS | |||||||
|               multiperiod/multicolumn report by year |               multiperiod/multicolumn report by year | ||||||
| 
 | 
 | ||||||
|        -p --period=PERIODEXP |        -p --period=PERIODEXP | ||||||
|               set start date, end date, and/or reporting interval all at  once |               set  start date, end date, and/or reporting interval all at once | ||||||
|               using period expressions syntax |               using period expressions syntax | ||||||
| 
 | 
 | ||||||
|        --date2 |        --date2 | ||||||
| @ -135,21 +136,21 @@ OPTIONS | |||||||
|               hide/aggregate accounts or postings more than NUM levels deep |               hide/aggregate accounts or postings more than NUM levels deep | ||||||
| 
 | 
 | ||||||
|        -E --empty |        -E --empty | ||||||
|               show items with zero amount, normally hidden (and vice-versa  in |               show  items with zero amount, normally hidden (and vice-versa in | ||||||
|               hledger-ui/hledger-web) |               hledger-ui/hledger-web) | ||||||
| 
 | 
 | ||||||
|        -B --cost |        -B --cost | ||||||
|               convert amounts to their cost/selling amount at transaction time |               convert amounts to their cost/selling amount at transaction time | ||||||
| 
 | 
 | ||||||
|        -V --market |        -V --market | ||||||
|               convert  amounts to their market value in default valuation com- |               convert amounts to their market value in default valuation  com- | ||||||
|               modities |               modities | ||||||
| 
 | 
 | ||||||
|        -X --exchange=COMM |        -X --exchange=COMM | ||||||
|               convert amounts to their market value in commodity COMM |               convert amounts to their market value in commodity COMM | ||||||
| 
 | 
 | ||||||
|        --value |        --value | ||||||
|               convert amounts to cost or  market  value,  more  flexibly  than |               convert  amounts  to  cost  or  market value, more flexibly than | ||||||
|               -B/-V/-X |               -B/-V/-X | ||||||
| 
 | 
 | ||||||
|        --infer-value |        --infer-value | ||||||
| @ -158,15 +159,15 @@ OPTIONS | |||||||
|        --auto apply automated posting rules to modify transactions. |        --auto apply automated posting rules to modify transactions. | ||||||
| 
 | 
 | ||||||
|        --forecast |        --forecast | ||||||
|               generate  future  transactions  from periodic transaction rules, |               generate future transactions from  periodic  transaction  rules, | ||||||
|               for the next 6 months or till report end date.   In  hledger-ui, |               for  the  next 6 months or till report end date.  In hledger-ui, | ||||||
|               also make ordinary future transactions visible. |               also make ordinary future transactions visible. | ||||||
| 
 | 
 | ||||||
|        --color=WHEN (or --colour=WHEN) |        --color=WHEN (or --colour=WHEN) | ||||||
|               Should  color-supporting  commands  use ANSI color codes in text |               Should color-supporting commands use ANSI color  codes  in  text | ||||||
|               output.  'auto' (default): whenever stdout seems to be a  color- |               output.   'auto' (default): whenever stdout seems to be a color- | ||||||
|               supporting  terminal.  'always' or 'yes': always, useful eg when |               supporting terminal.  'always' or 'yes': always, useful eg  when | ||||||
|               piping output into  'less  -R'.   'never'  or  'no':  never.   A |               piping  output  into  'less  -R'.   'never'  or  'no': never.  A | ||||||
|               NO_COLOR environment variable overrides this. |               NO_COLOR environment variable overrides this. | ||||||
| 
 | 
 | ||||||
|        When a reporting option appears more than once in the command line, the |        When a reporting option appears more than once in the command line, the | ||||||
| @ -186,91 +187,91 @@ OPTIONS | |||||||
|               show debug output (levels 1-9, default: 1) |               show debug output (levels 1-9, default: 1) | ||||||
| 
 | 
 | ||||||
|        A @FILE argument will be expanded to the contents of FILE, which should |        A @FILE argument will be expanded to the contents of FILE, which should | ||||||
|        contain  one  command line option/argument per line.  (To prevent this, |        contain one command line option/argument per line.  (To  prevent  this, | ||||||
|        insert a -- argument before.) |        insert a -- argument before.) | ||||||
| 
 | 
 | ||||||
| KEYS | KEYS | ||||||
|        ? shows a help dialog listing all keys.  (Some of these also appear  in |        ?  shows a help dialog listing all keys.  (Some of these also appear in | ||||||
|        the quick help at the bottom of each screen.) Press ? again (or ESCAPE, |        the quick help at the bottom of each screen.) Press ? again (or ESCAPE, | ||||||
|        or LEFT, or q) to close it.  The following keys work on most screens: |        or LEFT, or q) to close it.  The following keys work on most screens: | ||||||
| 
 | 
 | ||||||
|        The cursor keys navigate: right (or enter) goes deeper, left returns to |        The cursor keys navigate: right (or enter) goes deeper, left returns to | ||||||
|        the  previous  screen,  up/down/page  up/page down/home/end move up and |        the previous screen, up/down/page up/page  down/home/end  move  up  and | ||||||
|        down through lists.  Emacs-style (ctrl-p/ctrl-n/ctrl-f/ctrl-b) movement |        down through lists.  Emacs-style (ctrl-p/ctrl-n/ctrl-f/ctrl-b) movement | ||||||
|        keys  are  also  supported  (but not vi-style keys, since hledger-1.19, |        keys are also supported (but not  vi-style  keys,  since  hledger-1.19, | ||||||
|        sorry!).  A tip: movement speed is  limited  by  your  keyboard  repeat |        sorry!).   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, |        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.) |        the karabiner app is one way to do that.) | ||||||
| 
 | 
 | ||||||
|        With shift pressed, the cursor keys adjust the report period,  limiting |        With  shift pressed, the cursor keys adjust the report period, limiting | ||||||
|        the  transactions  to  be  shown  (by  default, all are shown).  shift- |        the transactions to be shown  (by  default,  all  are  shown).   shift- | ||||||
|        down/up steps downward and upward through these standard report  period |        down/up  steps downward and upward through these standard report period | ||||||
|        durations:  year,  quarter,  month,  week, day.  Then, shift-left/right |        durations: year, quarter, month,  week,  day.   Then,  shift-left/right | ||||||
|        moves to the previous/next period.  T sets the report period to  today. |        moves  to the previous/next period.  T sets the report period to today. | ||||||
|        With  the  --watch option, when viewing a "current" period (the current |        With the --watch option, when viewing a "current" period  (the  current | ||||||
|        day, week, month, quarter, or year), the period will move automatically |        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 / |        to track the current date.  To set a non-standard period, you can use / | ||||||
|        and a date: query. |        and a date: query. | ||||||
| 
 | 
 | ||||||
|        / lets you set a general filter query limiting the  data  shown,  using |        /  lets  you  set a general filter query limiting the data shown, using | ||||||
|        the  same query terms as in hledger and hledger-web.  While editing the |        the same query terms as in hledger and hledger-web.  While editing  the | ||||||
|        query, you can use CTRL-a/e/d/k, BS, cursor keys; press  ENTER  to  set |        query,  you  can  use CTRL-a/e/d/k, BS, cursor keys; press ENTER to set | ||||||
|        it, or ESCAPEto cancel.  There are also keys for quickly adjusting some |        it, or ESCAPEto cancel.  There are also keys for quickly adjusting some | ||||||
|        common filters like account depth and transaction status  (see  below). |        common  filters  like account depth and transaction status (see below). | ||||||
|        BACKSPACE or DELETE removes all filters, showing all transactions. |        BACKSPACE or DELETE removes all filters, showing all transactions. | ||||||
| 
 | 
 | ||||||
|        As  mentioned  above, by default hledger-ui hides future transactions - |        As mentioned above, by default hledger-ui hides future  transactions  - | ||||||
|        both ordinary transactions recorded in the journal, and periodic trans- |        both ordinary transactions recorded in the journal, and periodic trans- | ||||||
|        actions  generated  by  rule.   F  toggles  forecast mode, in which fu- |        actions generated by rule.  F  toggles  forecast  mode,  in  which  fu- | ||||||
|        ture/forecasted transactions are shown. |        ture/forecasted transactions are shown. | ||||||
| 
 | 
 | ||||||
|        ESCAPE resets the UI state and jumps back to the top screen,  restoring |        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 en- |        the app's initial state at startup.  Or, it cancels minibuffer data en- | ||||||
|        try or the help dialog. |        try or the help dialog. | ||||||
| 
 | 
 | ||||||
|        CTRL-l redraws the screen and centers the selection if possible (selec- |        CTRL-l redraws the screen and centers the selection if possible (selec- | ||||||
|        tions  near  the top won't be centered, since we don't scroll above the |        tions near the top won't be centered, since we don't scroll  above  the | ||||||
|        top). |        top). | ||||||
| 
 | 
 | ||||||
|        g reloads from the data file(s) and updates the current screen and  any |        g  reloads from the data file(s) and updates the current screen and any | ||||||
|        previous  screens.   (With  large  files, this could cause a noticeable |        previous screens.  (With large files, this  could  cause  a  noticeable | ||||||
|        pause.) |        pause.) | ||||||
| 
 | 
 | ||||||
|        I toggles balance assertion  checking.   Disabling  balance  assertions |        I  toggles  balance  assertion  checking.  Disabling balance assertions | ||||||
|        temporarily can be useful for troubleshooting. |        temporarily can be useful for troubleshooting. | ||||||
| 
 | 
 | ||||||
|        a  runs  command-line  hledger's  add  command, and reloads the updated |        a runs command-line hledger's add  command,  and  reloads  the  updated | ||||||
|        file.  This allows some basic data entry. |        file.  This allows some basic data entry. | ||||||
| 
 | 
 | ||||||
|        A is like a, but runs the hledger-iadd tool, which provides a  terminal |        A  is like a, but runs the hledger-iadd tool, which provides a terminal | ||||||
|        interface.   This key will be available if hledger-iadd is installed in |        interface.  This key will be available if hledger-iadd is installed  in | ||||||
|        $path. |        $path. | ||||||
| 
 | 
 | ||||||
|        E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacsclient -a  "" |        E  runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacsclient -a "" | ||||||
|        -nw)  on  the  journal file.  With some editors (emacs, vi), the cursor |        -nw) on the journal file.  With some editors (emacs,  vi),  the  cursor | ||||||
|        will be positioned at the current transaction  when  invoked  from  the |        will  be  positioned  at  the current transaction when invoked from the | ||||||
|        register  and transaction screens, and at the error location (if possi- |        register and transaction screens, and at the error location (if  possi- | ||||||
|        ble) when invoked from the error screen. |        ble) when invoked from the error screen. | ||||||
| 
 | 
 | ||||||
|        B toggles cost mode, showing amounts in their transaction price's  com- |        B  toggles cost mode, showing amounts in their transaction price's com- | ||||||
|        modity (like toggling the -B/--cost flag). |        modity (like toggling the -B/--cost flag). | ||||||
| 
 | 
 | ||||||
|        V  toggles  value  mode, showing amounts' current market value in their |        V toggles value mode, showing amounts' current market  value  in  their | ||||||
|        default valuation  commodity  (like  toggling  the  -V/--market  flag). |        default  valuation  commodity  (like  toggling  the  -V/--market flag). | ||||||
|        Note,  "current market value" means the value on the report end date if |        Note, "current market value" means the value on the report end date  if | ||||||
|        specified, otherwise today.  To see the value on another date, you  can |        specified,  otherwise today.  To see the value on another date, you can | ||||||
|        temporarily  set that as the report end date.  Eg: to see a transaction |        temporarily set that as the report end date.  Eg: to see a  transaction | ||||||
|        as it was valued on july 30, go to the  accounts  or  register  screen, |        as  it  was  valued  on july 30, go to the accounts or register screen, | ||||||
|        press /, and add date:-7/30 to the query. |        press /, and add date:-7/30 to the query. | ||||||
| 
 | 
 | ||||||
|        At most one of cost or value mode can be active at once. |        At most one of cost or value mode can be active at once. | ||||||
| 
 | 
 | ||||||
|        There's  not yet any visual reminder when cost or value mode is active; |        There's not yet any visual reminder when cost or value mode is  active; | ||||||
|        for now pressing b b v should reliably reset to normal mode. |        for now pressing b b v should reliably reset to normal mode. | ||||||
| 
 | 
 | ||||||
|        With --watch active, if you save an edit  to  the  journal  file  while |        With  --watch  active,  if  you  save an edit to the journal file while | ||||||
|        viewing the transaction screen in cost or value mode, the B/V keys will |        viewing the transaction screen in cost or value mode, the B/V keys will | ||||||
|        stop working.  To work around, press g to force  a  manual  reload,  or |        stop  working.   To  work  around, press g to force a manual reload, or | ||||||
|        exit the transaction screen. |        exit the transaction screen. | ||||||
| 
 | 
 | ||||||
|        q quits the application. |        q quits the application. | ||||||
| @ -279,43 +280,43 @@ KEYS | |||||||
| 
 | 
 | ||||||
| SCREENS | SCREENS | ||||||
|    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).  If you specify a query on the command line, it  shows |        of  subaccounts).  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 be- |        counts, except where subaccounts are hidden by a depth limit  (see  be- | ||||||
|        low).  In tree mode, all account balances are inclusive of subaccounts. |        low).  In tree mode, all account balances are inclusive of subaccounts. | ||||||
| 
 | 
 | ||||||
|        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 ES- |        depth limit, set it higher than the maximum account depth, or press ES- | ||||||
|        CAPE. |        CAPE. | ||||||
| 
 | 
 | ||||||
|        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  be- |        disturbed  by a filter query).  Period balances ignore transactions be- | ||||||
|        fore  the  report start date, so they show the change in balance during |        fore 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 in- |        if you activate one or two status filters, only those postings are  in- | ||||||
|        cluded; and if you activate all three, the filter is removed.) |        cluded; 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 or enter to view an account's transactions register. |        Press right or enter to view an account's transactions register. | ||||||
| @ -324,63 +325,63 @@ SCREENS | |||||||
|        This screen shows the transactions affecting a particular account, like |        This screen shows the transactions affecting a particular account, like | ||||||
|        a check register.  Each line represents one transaction and shows: |        a check register.  Each line represents one transaction and shows: | ||||||
| 
 | 
 | ||||||
|        o the  other  account(s)  involved, in abbreviated form.  (If there are |        o the other account(s) involved, in abbreviated form.   (If  there  are | ||||||
|          both real and virtual postings, it shows only the  accounts  affected |          both  real  and virtual postings, it shows only the accounts affected | ||||||
|          by real postings.) |          by real postings.) | ||||||
| 
 | 
 | ||||||
|        o the  overall change to the current account's balance; positive for an |        o the overall change to the current account's balance; positive for  an | ||||||
|          inflow to this account, negative for an outflow. |          inflow to this account, negative for an outflow. | ||||||
| 
 | 
 | ||||||
|        o the running historical total or period total for the current account, |        o the running historical total or period total for the current account, | ||||||
|          after  the  transaction.  This can be toggled with H.  Similar to the |          after the transaction.  This can be toggled with H.  Similar  to  the | ||||||
|          accounts screen, the historical total  is  affected  by  transactions |          accounts  screen,  the  historical  total is affected by transactions | ||||||
|          (filtered  by  the  filter query) before the report start date, while |          (filtered by the filter query) before the report  start  date,  while | ||||||
|          the period total is not.  If the historical total is not disturbed by |          the period total is not.  If the historical total is not disturbed by | ||||||
|          a  filter  query, it will be the running historical balance you would |          a filter query, it will be the running historical balance  you  would | ||||||
|          see on a bank register for the current account. |          see on a bank register for the current account. | ||||||
| 
 | 
 | ||||||
|        Transactions affecting this account's subaccounts will be  included  in |        Transactions  affecting  this account's subaccounts will be included in | ||||||
|        the register if the accounts screen is in tree mode, or if it's in list |        the register if the accounts screen is in tree mode, or if it's in list | ||||||
|        mode but this account has subaccounts which are  not  shown  due  to  a |        mode  but  this  account  has  subaccounts which are not shown due to a | ||||||
|        depth  limit.   In  other words, the register always shows the transac- |        depth limit.  In other words, the register always  shows  the  transac- | ||||||
|        tions contributing to the balance shown on the accounts  screen.   Tree |        tions  contributing  to the balance shown on the accounts screen.  Tree | ||||||
|        mode/list mode can be toggled with t here also. |        mode/list mode can be toggled with t here also. | ||||||
| 
 | 
 | ||||||
|        U  toggles  filtering  by  unmarked  status, showing or hiding unmarked |        U toggles filtering by unmarked  status,  showing  or  hiding  unmarked | ||||||
|        transactions.  Similarly, P toggles pending transactions, and C toggles |        transactions.  Similarly, P toggles pending transactions, and C toggles | ||||||
|        cleared  transactions.  (By default, transactions with all statuses are |        cleared transactions.  (By default, transactions with all statuses  are | ||||||
|        shown; if you activate one or two status filters, only  those  transac- |        shown;  if  you activate one or two status filters, only those transac- | ||||||
|        tions are shown; and if you activate all three, the filter is removed.) |        tions are shown; 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 transactions posting a nonzero |        Z toggles nonzero mode, in which only transactions  posting  a  nonzero | ||||||
|        change are shown (hledger-ui shows zero items by default,  unlike  com- |        change  are  shown (hledger-ui shows zero items by default, unlike com- | ||||||
|        mand-line hledger). |        mand-line hledger). | ||||||
| 
 | 
 | ||||||
|        Press right (or enter) to view the selected transaction in detail. |        Press right (or enter) to view the selected transaction in detail. | ||||||
| 
 | 
 | ||||||
|    Transaction screen |    Transaction screen | ||||||
|        This  screen  shows  a  single transaction, as a general journal entry, |        This screen shows a single transaction, as  a  general  journal  entry, | ||||||
|        similar to hledger's print command and  journal  format  (hledger_jour- |        similar  to  hledger's  print command and journal format (hledger_jour- | ||||||
|        nal(5)). |        nal(5)). | ||||||
| 
 | 
 | ||||||
|        The  transaction's  date(s) and any cleared flag, transaction code, de- |        The transaction's date(s) and any cleared flag, transaction  code,  de- | ||||||
|        scription, comments, along with all of its account postings are  shown. |        scription,  comments, along with all of its account postings are shown. | ||||||
|        Simple  transactions  have  two  postings, but there can be more (or in |        Simple transactions have two postings, but there can  be  more  (or  in | ||||||
|        certain cases, fewer). |        certain cases, fewer). | ||||||
| 
 | 
 | ||||||
|        up and down will step through all transactions listed in  the  previous |        up  and  down will step through all transactions listed in the previous | ||||||
|        account  register screen.  In the title bar, the numbers in parentheses |        account register screen.  In the title bar, the numbers in  parentheses | ||||||
|        show your position within that account register.  They  will  vary  de- |        show  your  position  within that account register.  They will vary de- | ||||||
|        pending on which account register you came from (remember most transac- |        pending on which account register you came from (remember most transac- | ||||||
|        tions appear in multiple account registers).  The #N  number  preceding |        tions  appear  in multiple account registers).  The #N number preceding | ||||||
|        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). | ||||||
| 
 | 
 | ||||||
|    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 | ||||||
|        again to reload and resume normal operation.  (Or, you can press escape |        again to reload and resume normal operation.  (Or, you can press escape | ||||||
|        to cancel the reload attempt.) |        to cancel the reload attempt.) | ||||||
| 
 | 
 | ||||||
| @ -388,15 +389,15 @@ ENVIRONMENT | |||||||
|        COLUMNS The screen width to use.  Default: the full terminal width. |        COLUMNS The screen width to use.  Default: the full terminal width. | ||||||
| 
 | 
 | ||||||
|        LEDGER_FILE The journal file path when not specified with -f.  Default: |        LEDGER_FILE The journal file path when not specified with -f.  Default: | ||||||
|        ~/.hledger.journal (on  windows,  perhaps  C:/Users/USER/.hledger.jour- |        ~/.hledger.journal  (on  windows,  perhaps C:/Users/USER/.hledger.jour- | ||||||
|        nal). |        nal). | ||||||
| 
 | 
 | ||||||
|        A  typical  value  is  ~/DIR/YYYY.journal,  where DIR is a version-con- |        A typical value is ~/DIR/YYYY.journal,  where  DIR  is  a  version-con- | ||||||
|        trolled finance directory and YYYY is the current year.  Or  ~/DIR/cur- |        trolled  finance directory and YYYY is the current year.  Or ~/DIR/cur- | ||||||
|        rent.journal, where current.journal is a symbolic link to YYYY.journal. |        rent.journal, where current.journal is a symbolic link to YYYY.journal. | ||||||
| 
 | 
 | ||||||
|        On Mac computers, you can set this and other environment variables in a |        On Mac computers, you can set this and other environment variables in a | ||||||
|        more thorough way that also affects applications started from  the  GUI |        more  thorough  way that also affects applications started from the GUI | ||||||
|        (say, an Emacs dock icon).  Eg on MacOS Catalina I have a ~/.MacOSX/en- |        (say, an Emacs dock icon).  Eg on MacOS Catalina I have a ~/.MacOSX/en- | ||||||
|        vironment.plist file containing |        vironment.plist file containing | ||||||
| 
 | 
 | ||||||
| @ -407,13 +408,13 @@ ENVIRONMENT | |||||||
|        To see the effect you may need to killall Dock, or reboot. |        To see the effect you may need to killall Dock, or reboot. | ||||||
| 
 | 
 | ||||||
| FILES | FILES | ||||||
|        Reads data from one or more files in hledger journal, timeclock,  time- |        Reads  data from one or more files in hledger journal, timeclock, time- | ||||||
|        dot,   or   CSV   format   specified   with  -f,  or  $LEDGER_FILE,  or |        dot,  or  CSV  format  specified   with   -f,   or   $LEDGER_FILE,   or | ||||||
|        $HOME/.hledger.journal          (on          windows,           perhaps |        $HOME/.hledger.journal           (on          windows,          perhaps | ||||||
|        C:/Users/USER/.hledger.journal). |        C:/Users/USER/.hledger.journal). | ||||||
| 
 | 
 | ||||||
| BUGS | BUGS | ||||||
|        The  need  to precede options with -- when invoked from hledger is awk- |        The need to precede options with -- when invoked from hledger  is  awk- | ||||||
|        ward. |        ward. | ||||||
| 
 | 
 | ||||||
|        -f- doesn't work (hledger-ui can't read from stdin). |        -f- doesn't work (hledger-ui can't read from stdin). | ||||||
| @ -421,24 +422,24 @@ BUGS | |||||||
|        -V affects only the accounts screen. |        -V affects only the accounts screen. | ||||||
| 
 | 
 | ||||||
|        When you press g, the current and all previous screens are regenerated, |        When you press g, the current and all previous screens are regenerated, | ||||||
|        which  may cause a noticeable pause with large files.  Also there is no |        which may cause a noticeable pause with large files.  Also there is  no | ||||||
|        visual indication that this is in progress. |        visual indication that this is in progress. | ||||||
| 
 | 
 | ||||||
|        --watch is not yet fully robust.  It works well for normal  usage,  but |        --watch  is  not yet fully robust.  It works well for normal usage, but | ||||||
|        many  file  changes  in  a  short time (eg saving the file thousands of |        many file changes in a short time (eg  saving  the  file  thousands  of | ||||||
|        times with an editor macro) can cause problems at least on OSX.   Symp- |        times  with an editor macro) can cause problems at least on OSX.  Symp- | ||||||
|        toms  include:  unresponsive UI, periodic resetting of the cursor posi- |        toms include: unresponsive UI, periodic resetting of the  cursor  posi- | ||||||
|        tion, momentary display of parse errors, high CPU usage eventually sub- |        tion, momentary display of parse errors, high CPU usage eventually sub- | ||||||
|        siding, and possibly a small but persistent build-up of CPU usage until |        siding, and possibly a small but persistent build-up of CPU usage until | ||||||
|        the program is restarted. |        the program is restarted. | ||||||
| 
 | 
 | ||||||
|        Also, if you are viewing files mounted from  another  machine,  --watch |        Also,  if  you  are viewing files mounted from another machine, --watch | ||||||
|        requires that both machine clocks are roughly in step. |        requires that both machine clocks are roughly in step. | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| REPORTING BUGS | REPORTING BUGS | ||||||
|        Report  bugs at http://bugs.hledger.org (or on the #hledger IRC channel |        Report bugs at http://bugs.hledger.org (or on the #hledger IRC  channel | ||||||
|        or hledger mail list) |        or hledger mail list) | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| @ -454,9 +455,6 @@ COPYRIGHT | |||||||
| SEE ALSO | SEE ALSO | ||||||
|        hledger(1), hledger-ui(1), hledger-web(1), ledger(1) |        hledger(1), hledger-ui(1), hledger-web(1), ledger(1) | ||||||
| 
 | 
 | ||||||
|        hledger_journal(5), hledger_csv(5), hledger_timeclock(5), hledger_time- |  | ||||||
|        dot(5) |  | ||||||
| 
 |  | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| hledger-ui-1.20.99               December 2020                   HLEDGER-UI(1) | hledger-ui-1.20.99               December 2020                   HLEDGER-UI(1) | ||||||
|  | |||||||
| @ -5,7 +5,8 @@ | |||||||
| 
 | 
 | ||||||
| .SH NAME | .SH NAME | ||||||
| .PP | .PP | ||||||
| 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.20.99. | ||||||
| .SH SYNOPSIS | .SH SYNOPSIS | ||||||
| .PP | .PP | ||||||
| \f[C]hledger-web [OPTIONS]\f[R] | \f[C]hledger-web [OPTIONS]\f[R] | ||||||
| @ -611,5 +612,3 @@ Released under GNU GPL v3 or later. | |||||||
| 
 | 
 | ||||||
| .SH SEE ALSO | .SH SEE ALSO | ||||||
| hledger(1), hledger\-ui(1), hledger\-web(1), ledger(1) | hledger(1), hledger\-ui(1), hledger\-web(1), ledger(1) | ||||||
| 
 |  | ||||||
| hledger_journal(5), hledger_csv(5), hledger_timeclock(5), hledger_timedot(5) |  | ||||||
|  | |||||||
| @ -6,7 +6,8 @@ File: hledger-web.info,  Node: Top,  Next: OPTIONS,  Up: (dir) | |||||||
| hledger-web(1) | hledger-web(1) | ||||||
| ************** | ************** | ||||||
| 
 | 
 | ||||||
| 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.20.99. | ||||||
| 
 | 
 | ||||||
|    'hledger-web [OPTIONS]' |    'hledger-web [OPTIONS]' | ||||||
| 'hledger web -- [OPTIONS]' | 'hledger web -- [OPTIONS]' | ||||||
| @ -589,21 +590,21 @@ awkward. | |||||||
|  |  | ||||||
| Tag Table: | Tag Table: | ||||||
| Node: Top72 | Node: Top72 | ||||||
| Node: OPTIONS1707 | Node: OPTIONS1762 | ||||||
| Ref: #options1812 | Ref: #options1867 | ||||||
| Node: PERMISSIONS8911 | Node: PERMISSIONS8966 | ||||||
| Ref: #permissions9050 | Ref: #permissions9105 | ||||||
| Node: EDITING UPLOADING DOWNLOADING10262 | Node: EDITING UPLOADING DOWNLOADING10317 | ||||||
| Ref: #editing-uploading-downloading10443 | Ref: #editing-uploading-downloading10498 | ||||||
| Node: RELOADING11277 | Node: RELOADING11332 | ||||||
| Ref: #reloading11411 | Ref: #reloading11466 | ||||||
| Node: JSON API11844 | Node: JSON API11899 | ||||||
| Ref: #json-api11958 | Ref: #json-api12013 | ||||||
| Node: ENVIRONMENT17448 | Node: ENVIRONMENT17503 | ||||||
| Ref: #environment17564 | Ref: #environment17619 | ||||||
| Node: FILES18297 | Node: FILES18352 | ||||||
| Ref: #files18397 | Ref: #files18452 | ||||||
| Node: BUGS18610 | Node: BUGS18665 | ||||||
| Ref: #bugs18688 | Ref: #bugs18743 | ||||||
|  |  | ||||||
| End Tag Table | End Tag Table | ||||||
|  | |||||||
| @ -4,50 +4,51 @@ HLEDGER-WEB(1)               hledger User Manuals               HLEDGER-WEB(1) | |||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| NAME | NAME | ||||||
|        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.20.99. | ||||||
| 
 | 
 | ||||||
| SYNOPSIS | SYNOPSIS | ||||||
|        hledger-web [OPTIONS] |        hledger-web [OPTIONS] | ||||||
|        hledger web -- [OPTIONS] |        hledger web -- [OPTIONS] | ||||||
| 
 | 
 | ||||||
| DESCRIPTION | DESCRIPTION | ||||||
|        hledger  is  a  reliable,  cross-platform  set of programs for tracking |        hledger is a reliable, cross-platform  set  of  programs  for  tracking | ||||||
|        money, time, or any other commodity, using double-entry accounting  and |        money,  time, or any other commodity, using double-entry accounting and | ||||||
|        a  simple,  editable  file  format.  hledger is inspired by and largely |        a simple, editable file format.  hledger is  inspired  by  and  largely | ||||||
|        compatible with ledger(1). |        compatible with ledger(1). | ||||||
| 
 | 
 | ||||||
|        hledger-web is hledger's web interface.  It starts a simple web  appli- |        hledger-web  is hledger's web interface.  It starts a simple web appli- | ||||||
|        cation for browsing and adding transactions, and optionally opens it in |        cation for browsing and adding transactions, and optionally opens it in | ||||||
|        a web browser window if possible.  It provides a more user-friendly  UI |        a  web browser window if possible.  It provides a more user-friendly UI | ||||||
|        than the hledger CLI or hledger-ui interface, showing more at once (ac- |        than the hledger CLI or hledger-ui interface, showing more at once (ac- | ||||||
|        counts, the current account register, balance charts) and allowing his- |        counts, the current account register, balance charts) and allowing his- | ||||||
|        tory-aware data entry, interactive searching, and bookmarking. |        tory-aware data entry, interactive searching, and bookmarking. | ||||||
| 
 | 
 | ||||||
|        hledger-web  also  lets you share a ledger with multiple users, or even |        hledger-web also lets you share a ledger with multiple users,  or  even | ||||||
|        the public web.  There is no access control, so if you  need  that  you |        the  public  web.   There is no access control, so if you need that you | ||||||
|        should  put  it  behind  a  suitable  web proxy.  As a small protection |        should put it behind a suitable  web  proxy.   As  a  small  protection | ||||||
|        against data loss when running an unprotected  instance,  it  writes  a |        against  data  loss  when  running an unprotected instance, it writes a | ||||||
|        numbered backup of the main journal file (only ?)  on every edit. |        numbered backup of the main journal file (only ?)  on every edit. | ||||||
| 
 | 
 | ||||||
|        Like  hledger, it reads data from one or more files in hledger journal, |        Like hledger, it reads data from one or more files in hledger  journal, | ||||||
|        timeclock, timedot, or CSV format specified with -f,  or  $LEDGER_FILE, |        timeclock,  timedot,  or CSV format specified with -f, or $LEDGER_FILE, | ||||||
|        or        $HOME/.hledger.journal       (on       windows,       perhaps |        or       $HOME/.hledger.journal       (on       windows,        perhaps | ||||||
|        C:/Users/USER/.hledger.journal).  For more about this  see  hledger(1), |        C:/Users/USER/.hledger.journal).   For  more about this see hledger(1), | ||||||
|        hledger_journal(5) etc. |        hledger_journal(5) etc. | ||||||
| 
 | 
 | ||||||
| OPTIONS | OPTIONS | ||||||
|        Command-line options and arguments may be used to set an initial filter |        Command-line options and arguments may be used to set an initial filter | ||||||
|        on the data.  These filter options are not shown in the web UI, but  it |        on  the data.  These filter options are not shown in the web UI, but it | ||||||
|        will be applied in addition to any search query entered there. |        will be applied in addition to any search query entered there. | ||||||
| 
 | 
 | ||||||
|        Note:  if invoking hledger-web as a hledger subcommand, write -- before |        Note: if invoking hledger-web as a hledger subcommand, write --  before | ||||||
|        options, as shown in the synopsis above. |        options, as shown in the synopsis above. | ||||||
| 
 | 
 | ||||||
|        --serve |        --serve | ||||||
|               serve and log requests, don't browse or auto-exit |               serve and log requests, don't browse or auto-exit | ||||||
| 
 | 
 | ||||||
|        --serve-api |        --serve-api | ||||||
|               like --serve, but serve only  the  JSON  web  API,  without  the |               like  --serve,  but  serve  only  the  JSON web API, without the | ||||||
|               server-side web UI |               server-side web UI | ||||||
| 
 | 
 | ||||||
|        --host=IPADDR |        --host=IPADDR | ||||||
| @ -57,30 +58,30 @@ OPTIONS | |||||||
|               listen on this TCP port (default: 5000) |               listen on this TCP port (default: 5000) | ||||||
| 
 | 
 | ||||||
|        --socket=SOCKETFILE |        --socket=SOCKETFILE | ||||||
|               use  a unix domain socket file to listen for requests instead of |               use a unix domain socket file to listen for requests instead  of | ||||||
|               a TCP socket.  Implies --serve.  It can only be used if the  op- |               a  TCP socket.  Implies --serve.  It can only be used if the op- | ||||||
|               erating system can provide this type of socket. |               erating system can provide this type of socket. | ||||||
| 
 | 
 | ||||||
|        --base-url=URL |        --base-url=URL | ||||||
|               set  the  base  url  (default:  http://IPADDR:PORT).   You would |               set the  base  url  (default:  http://IPADDR:PORT).   You  would | ||||||
|               change this when sharing over the network, or integrating within |               change this when sharing over the network, or integrating within | ||||||
|               a larger website. |               a larger website. | ||||||
| 
 | 
 | ||||||
|        --file-url=URL |        --file-url=URL | ||||||
|               set the static files url (default: BASEURL/static).  hledger-web |               set the static files url (default: BASEURL/static).  hledger-web | ||||||
|               normally serves static files itself, but if you wanted to  serve |               normally  serves static files itself, but if you wanted to serve | ||||||
|               them  from  another server for efficiency, you would set the url |               them from another server for efficiency, you would set  the  url | ||||||
|               with this. |               with this. | ||||||
| 
 | 
 | ||||||
|        --capabilities=CAP[,CAP..] |        --capabilities=CAP[,CAP..] | ||||||
|               enable the  view,  add,  and/or  manage  capabilities  (default: |               enable  the  view,  add,  and/or  manage  capabilities (default: | ||||||
|               view,add) |               view,add) | ||||||
| 
 | 
 | ||||||
|        --capabilities-header=HTTPHEADER |        --capabilities-header=HTTPHEADER | ||||||
|               read  capabilities  to  enable  from a HTTP header, like X-Sand- |               read capabilities to enable from a  HTTP  header,  like  X-Sand- | ||||||
|               storm-Permissions (default: disabled) |               storm-Permissions (default: disabled) | ||||||
| 
 | 
 | ||||||
|        --test run hledger-web's tests and exit.  hspec test  runner  args  may |        --test run  hledger-web's  tests  and exit.  hspec test runner args may | ||||||
|               follow a --, eg: hledger-web --test -- --help |               follow a --, eg: hledger-web --test -- --help | ||||||
| 
 | 
 | ||||||
|        hledger input options: |        hledger input options: | ||||||
| @ -90,7 +91,7 @@ OPTIONS | |||||||
|               $LEDGER_FILE or $HOME/.hledger.journal) |               $LEDGER_FILE or $HOME/.hledger.journal) | ||||||
| 
 | 
 | ||||||
|        --rules-file=RULESFILE |        --rules-file=RULESFILE | ||||||
|               Conversion  rules  file  to  use  when  reading  CSV   (default: |               Conversion   rules  file  to  use  when  reading  CSV  (default: | ||||||
|               FILE.rules) |               FILE.rules) | ||||||
| 
 | 
 | ||||||
|        --separator=CHAR |        --separator=CHAR | ||||||
| @ -109,7 +110,7 @@ OPTIONS | |||||||
|               assignments) |               assignments) | ||||||
| 
 | 
 | ||||||
|        -s --strict |        -s --strict | ||||||
|               do extra error checking (check that all posted accounts are  de- |               do  extra error checking (check that all posted accounts are de- | ||||||
|               clared) |               clared) | ||||||
| 
 | 
 | ||||||
|        hledger reporting options: |        hledger reporting options: | ||||||
| @ -136,7 +137,7 @@ OPTIONS | |||||||
|               multiperiod/multicolumn report by year |               multiperiod/multicolumn report by year | ||||||
| 
 | 
 | ||||||
|        -p --period=PERIODEXP |        -p --period=PERIODEXP | ||||||
|               set  start date, end date, and/or reporting interval all at once |               set start date, end date, and/or reporting interval all at  once | ||||||
|               using period expressions syntax |               using period expressions syntax | ||||||
| 
 | 
 | ||||||
|        --date2 |        --date2 | ||||||
| @ -159,21 +160,21 @@ OPTIONS | |||||||
|               hide/aggregate accounts or postings more than NUM levels deep |               hide/aggregate accounts or postings more than NUM levels deep | ||||||
| 
 | 
 | ||||||
|        -E --empty |        -E --empty | ||||||
|               show  items with zero amount, normally hidden (and vice-versa in |               show items with zero amount, normally hidden (and vice-versa  in | ||||||
|               hledger-ui/hledger-web) |               hledger-ui/hledger-web) | ||||||
| 
 | 
 | ||||||
|        -B --cost |        -B --cost | ||||||
|               convert amounts to their cost/selling amount at transaction time |               convert amounts to their cost/selling amount at transaction time | ||||||
| 
 | 
 | ||||||
|        -V --market |        -V --market | ||||||
|               convert amounts to their market value in default valuation  com- |               convert  amounts to their market value in default valuation com- | ||||||
|               modities |               modities | ||||||
| 
 | 
 | ||||||
|        -X --exchange=COMM |        -X --exchange=COMM | ||||||
|               convert amounts to their market value in commodity COMM |               convert amounts to their market value in commodity COMM | ||||||
| 
 | 
 | ||||||
|        --value |        --value | ||||||
|               convert  amounts  to  cost  or  market value, more flexibly than |               convert amounts to cost or  market  value,  more  flexibly  than | ||||||
|               -B/-V/-X |               -B/-V/-X | ||||||
| 
 | 
 | ||||||
|        --infer-value |        --infer-value | ||||||
| @ -182,15 +183,15 @@ OPTIONS | |||||||
|        --auto apply automated posting rules to modify transactions. |        --auto apply automated posting rules to modify transactions. | ||||||
| 
 | 
 | ||||||
|        --forecast |        --forecast | ||||||
|               generate future transactions from  periodic  transaction  rules, |               generate  future  transactions  from periodic transaction rules, | ||||||
|               for  the  next 6 months or till report end date.  In hledger-ui, |               for the next 6 months or till report end date.   In  hledger-ui, | ||||||
|               also make ordinary future transactions visible. |               also make ordinary future transactions visible. | ||||||
| 
 | 
 | ||||||
|        --color=WHEN (or --colour=WHEN) |        --color=WHEN (or --colour=WHEN) | ||||||
|               Should color-supporting commands use ANSI color  codes  in  text |               Should  color-supporting  commands  use ANSI color codes in text | ||||||
|               output.   'auto' (default): whenever stdout seems to be a color- |               output.  'auto' (default): whenever stdout seems to be a  color- | ||||||
|               supporting terminal.  'always' or 'yes': always, useful eg  when |               supporting  terminal.  'always' or 'yes': always, useful eg when | ||||||
|               piping  output  into  'less  -R'.   'never'  or  'no': never.  A |               piping output into  'less  -R'.   'never'  or  'no':  never.   A | ||||||
|               NO_COLOR environment variable overrides this. |               NO_COLOR environment variable overrides this. | ||||||
| 
 | 
 | ||||||
|        When a reporting option appears more than once in the command line, the |        When a reporting option appears more than once in the command line, the | ||||||
| @ -210,54 +211,54 @@ OPTIONS | |||||||
|               show debug output (levels 1-9, default: 1) |               show debug output (levels 1-9, default: 1) | ||||||
| 
 | 
 | ||||||
|        A @FILE argument will be expanded to the contents of FILE, which should |        A @FILE argument will be expanded to the contents of FILE, which should | ||||||
|        contain one command line option/argument per line.  (To  prevent  this, |        contain  one  command line option/argument per line.  (To prevent this, | ||||||
|        insert a -- argument before.) |        insert a -- argument before.) | ||||||
| 
 | 
 | ||||||
|        By default, hledger-web starts the web app in "transient mode" and also |        By default, hledger-web starts the web app in "transient mode" and also | ||||||
|        opens it in your default web browser if possible.  In this mode the web |        opens it in your default web browser if possible.  In this mode the web | ||||||
|        app will keep running for as long as you have it open in a browser win- |        app will keep running for as long as you have it open in a browser win- | ||||||
|        dow, and will exit after two minutes of inactivity (no requests and  no |        dow,  and will exit after two minutes of inactivity (no requests and no | ||||||
|        browser  windows  viewing  it).  With --serve, it just runs the web app |        browser windows viewing it).  With --serve, it just runs  the  web  app | ||||||
|        without exiting, and logs requests to the console.   With  --serve-api, |        without  exiting,  and logs requests to the console.  With --serve-api, | ||||||
|        only  the  JSON  web  api  (see  below)  is served, with the usual HTML |        only the JSON web api (see  below)  is  served,  with  the  usual  HTML | ||||||
|        server-side web UI disabled. |        server-side web UI disabled. | ||||||
| 
 | 
 | ||||||
|        By default the server listens on IP address 127.0.0.1, accessible  only |        By  default the server listens on IP address 127.0.0.1, accessible only | ||||||
|        to  local  requests.   You  can  use  --host  to change this, eg --host |        to local requests.  You can  use  --host  to  change  this,  eg  --host | ||||||
|        0.0.0.0 to listen on all configured addresses. |        0.0.0.0 to listen on all configured addresses. | ||||||
| 
 | 
 | ||||||
|        Similarly, use --port to set a TCP port other than 5000, eg if you  are |        Similarly,  use --port to set a TCP port other than 5000, eg if you are | ||||||
|        running multiple hledger-web instances. |        running multiple hledger-web instances. | ||||||
| 
 | 
 | ||||||
|        Both of these options are ignored when --socket is used.  In this case, |        Both of these options are ignored when --socket is used.  In this case, | ||||||
|        it creates an AF_UNIX socket file at the supplied path  and  uses  that |        it  creates  an  AF_UNIX socket file at the supplied path and uses that | ||||||
|        for  communication.   This  is  an  alternative way of running multiple |        for communication.  This is an  alternative  way  of  running  multiple | ||||||
|        hledger-web instances behind a reverse proxy that  handles  authentica- |        hledger-web  instances  behind a reverse proxy that handles authentica- | ||||||
|        tion  for  different  users.   The path can be derived in a predictable |        tion for different users.  The path can be  derived  in  a  predictable | ||||||
|        way, eg by using the username within the path.  As an example, nginx as |        way, eg by using the username within the path.  As an example, nginx as | ||||||
|        reverse  proxy  can use the variable $remote_user to derive a path from |        reverse proxy can use the variable $remote_user to derive a  path  from | ||||||
|        the username used  in  a  HTTP  basic  authentication.   The  following |        the  username  used  in  a  HTTP  basic  authentication.  The following | ||||||
|        proxy_pass  directive  allows  access to all hledger-web instances that |        proxy_pass directive allows access to all  hledger-web  instances  that | ||||||
|        created a socket in /tmp/hledger/: |        created a socket in /tmp/hledger/: | ||||||
| 
 | 
 | ||||||
|                 proxy_pass http://unix:/tmp/hledger/${remote_user}.socket; |                 proxy_pass http://unix:/tmp/hledger/${remote_user}.socket; | ||||||
| 
 | 
 | ||||||
|        You can use --base-url to change the protocol, hostname, port and  path |        You  can use --base-url to change the protocol, hostname, port and path | ||||||
|        that appear in hyperlinks, useful eg for integrating hledger-web within |        that appear in hyperlinks, useful eg for integrating hledger-web within | ||||||
|        a larger website.  The default is http://HOST:PORT/ using the  server's |        a  larger website.  The default is http://HOST:PORT/ using the server's | ||||||
|        configured host address and TCP port (or http://HOST if PORT is 80). |        configured host address and TCP port (or http://HOST if PORT is 80). | ||||||
| 
 | 
 | ||||||
|        With  --file-url  you can set a different base url for static files, eg |        With --file-url you can set a different base url for static  files,  eg | ||||||
|        for better caching or cookie-less serving on high performance websites. |        for better caching or cookie-less serving on high performance websites. | ||||||
| 
 | 
 | ||||||
| PERMISSIONS | PERMISSIONS | ||||||
|        By default, hledger-web allows anyone who can  reach  it  to  view  the |        By  default,  hledger-web  allows  anyone  who can reach it to view the | ||||||
|        journal and to add new transactions, but not to change existing data. |        journal and to add new transactions, but not to change existing data. | ||||||
| 
 | 
 | ||||||
|        You can restrict who can reach it by |        You can restrict who can reach it by | ||||||
| 
 | 
 | ||||||
|        o setting  the IP address it listens on (see --host above).  By default |        o setting the IP address it listens on (see --host above).  By  default | ||||||
|          it listens on 127.0.0.1, accessible to all users  on  the  local  ma- |          it  listens  on  127.0.0.1,  accessible to all users on the local ma- | ||||||
|          chine. |          chine. | ||||||
| 
 | 
 | ||||||
|        o putting it behind an authenticating proxy, using eg apache or nginx |        o putting it behind an authenticating proxy, using eg apache or nginx | ||||||
| @ -267,44 +268,44 @@ PERMISSIONS | |||||||
|        You can restrict what the users who reach it can do, by |        You can restrict what the users who reach it can do, by | ||||||
| 
 | 
 | ||||||
|        o using the --capabilities=CAP[,CAP..] flag when you start it, enabling |        o using the --capabilities=CAP[,CAP..] flag when you start it, enabling | ||||||
|          one or more of the following  capabilities.   The  default  value  is |          one  or  more  of  the  following capabilities.  The default value is | ||||||
|          view,add: |          view,add: | ||||||
| 
 | 
 | ||||||
|          o view - allows viewing the journal file and all included files |          o view - allows viewing the journal file and all included files | ||||||
| 
 | 
 | ||||||
|          o add - allows adding new transactions to the main journal file |          o add - allows adding new transactions to the main journal file | ||||||
| 
 | 
 | ||||||
|          o manage  -  allows editing, uploading or downloading the main or in- |          o manage - allows editing, uploading or downloading the main  or  in- | ||||||
|            cluded files |            cluded files | ||||||
| 
 | 
 | ||||||
|        o using the --capabilities-header=HTTPHEADER flag  to  specify  a  HTTP |        o using  the  --capabilities-header=HTTPHEADER  flag  to specify a HTTP | ||||||
|          header  from  which it will read capabilities to enable.  hledger-web |          header from which it will read capabilities to  enable.   hledger-web | ||||||
|          on Sandstorm uses the  X-Sandstorm-Permissions  header  to  integrate |          on  Sandstorm  uses  the  X-Sandstorm-Permissions header to integrate | ||||||
|          with Sandstorm's permissions.  This is disabled by default. |          with Sandstorm's permissions.  This is disabled by default. | ||||||
| 
 | 
 | ||||||
| EDITING, UPLOADING, DOWNLOADING | EDITING, UPLOADING, DOWNLOADING | ||||||
|        If  you  enable the manage capability mentioned above, you'll see a new |        If you enable the manage capability mentioned above, you'll see  a  new | ||||||
|        "spanner" button to the right of the search form.  Clicking  this  will |        "spanner"  button  to the right of the search form.  Clicking this will | ||||||
|        let  you edit, upload, or download the journal file or any files it in- |        let you edit, upload, or download the journal file or any files it  in- | ||||||
|        cludes. |        cludes. | ||||||
| 
 | 
 | ||||||
|        Note, unlike any other hledger command, in this mode you (or any  visi- |        Note,  unlike any other hledger command, in this mode you (or any visi- | ||||||
|        tor) can alter or wipe the data files. |        tor) can alter or wipe the data files. | ||||||
| 
 | 
 | ||||||
|        Normally  whenever  a  file is changed in this way, hledger-web saves a |        Normally whenever a file is changed in this way,  hledger-web  saves  a | ||||||
|        numbered backup (assuming file permissions allow it, the  disk  is  not |        numbered  backup  (assuming  file permissions allow it, the disk is not | ||||||
|        full,  etc.)  hledger-web is not aware of version control systems, cur- |        full, etc.) hledger-web is not aware of version control  systems,  cur- | ||||||
|        rently; if you use one, you'll have to arrange to  commit  the  changes |        rently;  if  you  use one, you'll have to arrange to commit the changes | ||||||
|        yourself (eg with a cron job or a file watcher like entr). |        yourself (eg with a cron job or a file watcher like entr). | ||||||
| 
 | 
 | ||||||
|        Changes  which would leave the journal file(s) unparseable or non-valid |        Changes which would leave the journal file(s) unparseable or  non-valid | ||||||
|        (eg with failing balance assertions) are prevented.   (Probably.   This |        (eg  with  failing balance assertions) are prevented.  (Probably.  This | ||||||
|        needs re-testing.) |        needs re-testing.) | ||||||
| 
 | 
 | ||||||
| RELOADING | RELOADING | ||||||
|        hledger-web detects changes made to the files by other means (eg if you |        hledger-web detects changes made to the files by other means (eg if you | ||||||
|        edit it directly, outside of hledger-web), and it  will  show  the  new |        edit  it  directly,  outside  of hledger-web), and it will show the new | ||||||
|        data  when  you reload the page or navigate to a new page.  If a change |        data when you reload the page or navigate to a new page.  If  a  change | ||||||
|        makes a file unparseable, hledger-web will display an error message un- |        makes a file unparseable, hledger-web will display an error message un- | ||||||
|        til the file has been fixed. |        til the file has been fixed. | ||||||
| 
 | 
 | ||||||
| @ -312,8 +313,8 @@ RELOADING | |||||||
|        that both machine clocks are roughly in step.) |        that both machine clocks are roughly in step.) | ||||||
| 
 | 
 | ||||||
| JSON API | JSON API | ||||||
|        In addition to the web UI, hledger-web also serves a JSON API that  can |        In  addition to the web UI, hledger-web also serves a JSON API that can | ||||||
|        be  used to get data or add new transactions.  If you want the JSON API |        be used to get data or add new transactions.  If you want the JSON  API | ||||||
|        only, you can use the --serve-api flag.  Eg: |        only, you can use the --serve-api flag.  Eg: | ||||||
| 
 | 
 | ||||||
|               $ hledger-web -f examples/sample.journal --serve-api |               $ hledger-web -f examples/sample.journal --serve-api | ||||||
| @ -330,7 +331,7 @@ JSON API | |||||||
|               /accounttransactions/ACCOUNTNAME |               /accounttransactions/ACCOUNTNAME | ||||||
| 
 | 
 | ||||||
|        Eg, all account names in the journal (similar to the accounts command). |        Eg, all account names in the journal (similar to the accounts command). | ||||||
|        (hledger-web's  JSON  does  not include newlines, here we use python to |        (hledger-web's JSON does not include newlines, here we  use  python  to | ||||||
|        prettify it): |        prettify it): | ||||||
| 
 | 
 | ||||||
|               $ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool |               $ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool | ||||||
| @ -371,25 +372,25 @@ JSON API | |||||||
|                                       "aprice": null, |                                       "aprice": null, | ||||||
|               ... |               ... | ||||||
| 
 | 
 | ||||||
|        Most of the JSON corresponds to hledger's data types;  for  details  of |        Most  of  the  JSON corresponds to hledger's data types; for details of | ||||||
|        what  the fields mean, see the Hledger.Data.Json haddock docs and click |        what the fields mean, see the Hledger.Data.Json haddock docs and  click | ||||||
|        on the various data types, eg Transaction.  And for a higher level  un- |        on  the various data types, eg Transaction.  And for a higher level un- | ||||||
|        derstanding, see the journal manual. |        derstanding, see the journal manual. | ||||||
| 
 | 
 | ||||||
|        In some cases there is outer JSON corresponding to a "Report" type.  To |        In some cases there is outer JSON corresponding to a "Report" type.  To | ||||||
|        understand that, go to the Hledger.Web.Handler.MiscR haddock  and  look |        understand  that,  go to the Hledger.Web.Handler.MiscR haddock and look | ||||||
|        at  the  source for the appropriate handler to see what it returns.  Eg |        at the source for the appropriate handler to see what it  returns.   Eg | ||||||
|        for /accounttransactions it's getAccounttransactionsR, returning a "ac- |        for /accounttransactions it's getAccounttransactionsR, returning a "ac- | ||||||
|        countTransactionsReport  ...".   Looking up the haddock for that we can |        countTransactionsReport ...".  Looking up the haddock for that  we  can | ||||||
|        see that  /accounttransactions  returns  an  AccountTransactionsReport, |        see  that  /accounttransactions  returns  an AccountTransactionsReport, | ||||||
|        which  consists  of a report title and a list of AccountTransactionsRe- |        which consists of a report title and a list  of  AccountTransactionsRe- | ||||||
|        portItem (etc). |        portItem (etc). | ||||||
| 
 | 
 | ||||||
|        You can add a new transaction to the journal  with  a  PUT  request  to |        You  can  add  a  new  transaction to the journal with a PUT request to | ||||||
|        /add,  if  hledger-web  was started with the add capability (enabled by |        /add, if hledger-web was started with the add  capability  (enabled  by | ||||||
|        default).  The payload must be the full, exact JSON representation of a |        default).  The payload must be the full, exact JSON representation of a | ||||||
|        hledger  transaction  (partial data won't do).  You can get sample JSON |        hledger transaction (partial data won't do).  You can get  sample  JSON | ||||||
|        from hledger-web's /transactions or /accounttransactions,  or  you  can |        from  hledger-web's  /transactions  or /accounttransactions, or you can | ||||||
|        export it with hledger-lib, eg like so: |        export it with hledger-lib, eg like so: | ||||||
| 
 | 
 | ||||||
|               .../hledger$ stack ghci hledger-lib |               .../hledger$ stack ghci hledger-lib | ||||||
| @ -485,22 +486,22 @@ JSON API | |||||||
|                   "tstatus": "Unmarked" |                   "tstatus": "Unmarked" | ||||||
|               } |               } | ||||||
| 
 | 
 | ||||||
|        And here's how to test adding it with curl.  This should add a new  en- |        And  here's how to test adding it with curl.  This should add a new en- | ||||||
|        try to your journal: |        try to your journal: | ||||||
| 
 | 
 | ||||||
|               $ curl http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.json |               $ curl http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.json | ||||||
| 
 | 
 | ||||||
| ENVIRONMENT | ENVIRONMENT | ||||||
|        LEDGER_FILE The journal file path when not specified with -f.  Default: |        LEDGER_FILE The journal file path when not specified with -f.  Default: | ||||||
|        ~/.hledger.journal (on  windows,  perhaps  C:/Users/USER/.hledger.jour- |        ~/.hledger.journal  (on  windows,  perhaps C:/Users/USER/.hledger.jour- | ||||||
|        nal). |        nal). | ||||||
| 
 | 
 | ||||||
|        A  typical  value  is  ~/DIR/YYYY.journal,  where DIR is a version-con- |        A typical value is ~/DIR/YYYY.journal,  where  DIR  is  a  version-con- | ||||||
|        trolled finance directory and YYYY is the current year.  Or  ~/DIR/cur- |        trolled  finance directory and YYYY is the current year.  Or ~/DIR/cur- | ||||||
|        rent.journal, where current.journal is a symbolic link to YYYY.journal. |        rent.journal, where current.journal is a symbolic link to YYYY.journal. | ||||||
| 
 | 
 | ||||||
|        On Mac computers, you can set this and other environment variables in a |        On Mac computers, you can set this and other environment variables in a | ||||||
|        more thorough way that also affects applications started from  the  GUI |        more  thorough  way that also affects applications started from the GUI | ||||||
|        (say, an Emacs dock icon).  Eg on MacOS Catalina I have a ~/.MacOSX/en- |        (say, an Emacs dock icon).  Eg on MacOS Catalina I have a ~/.MacOSX/en- | ||||||
|        vironment.plist file containing |        vironment.plist file containing | ||||||
| 
 | 
 | ||||||
| @ -511,13 +512,13 @@ ENVIRONMENT | |||||||
|        To see the effect you may need to killall Dock, or reboot. |        To see the effect you may need to killall Dock, or reboot. | ||||||
| 
 | 
 | ||||||
| FILES | FILES | ||||||
|        Reads data from one or more files in hledger journal, timeclock,  time- |        Reads  data from one or more files in hledger journal, timeclock, time- | ||||||
|        dot,   or   CSV   format   specified   with  -f,  or  $LEDGER_FILE,  or |        dot,  or  CSV  format  specified   with   -f,   or   $LEDGER_FILE,   or | ||||||
|        $HOME/.hledger.journal          (on          windows,           perhaps |        $HOME/.hledger.journal           (on          windows,          perhaps | ||||||
|        C:/Users/USER/.hledger.journal). |        C:/Users/USER/.hledger.journal). | ||||||
| 
 | 
 | ||||||
| BUGS | BUGS | ||||||
|        The  need  to precede options with -- when invoked from hledger is awk- |        The need to precede options with -- when invoked from hledger  is  awk- | ||||||
|        ward. |        ward. | ||||||
| 
 | 
 | ||||||
|        -f- doesn't work (hledger-web can't read from stdin). |        -f- doesn't work (hledger-web can't read from stdin). | ||||||
| @ -531,7 +532,7 @@ BUGS | |||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| REPORTING BUGS | REPORTING BUGS | ||||||
|        Report bugs at http://bugs.hledger.org (or on the #hledger IRC  channel |        Report  bugs at http://bugs.hledger.org (or on the #hledger IRC channel | ||||||
|        or hledger mail list) |        or hledger mail list) | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| @ -547,9 +548,6 @@ COPYRIGHT | |||||||
| SEE ALSO | SEE ALSO | ||||||
|        hledger(1), hledger-ui(1), hledger-web(1), ledger(1) |        hledger(1), hledger-ui(1), hledger-web(1), ledger(1) | ||||||
| 
 | 
 | ||||||
|        hledger_journal(5), hledger_csv(5), hledger_timeclock(5), hledger_time- |  | ||||||
|        dot(5) |  | ||||||
| 
 |  | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| hledger-web-1.20.99              December 2020                  HLEDGER-WEB(1) | hledger-web-1.20.99              December 2020                  HLEDGER-WEB(1) | ||||||
|  | |||||||
| @ -6,8 +6,9 @@ | |||||||
| 
 | 
 | ||||||
| .SH NAME | .SH NAME | ||||||
| .PP | .PP | ||||||
| A command-line accounting tool for both power users and folks new to | hledger is a command-line accounting tool for both power users and folks | ||||||
| accounting. | new to accounting. | ||||||
|  | This manual is for hledger 1.20.99. | ||||||
| .SH SYNOPSIS | .SH SYNOPSIS | ||||||
| .PP | .PP | ||||||
| \f[C]hledger\f[R] | \f[C]hledger\f[R] | ||||||
| @ -8993,5 +8994,3 @@ Released under GNU GPL v3 or later. | |||||||
| 
 | 
 | ||||||
| .SH SEE ALSO | .SH SEE ALSO | ||||||
| hledger(1), hledger\-ui(1), hledger\-web(1), ledger(1) | hledger(1), hledger\-ui(1), hledger\-web(1), ledger(1) | ||||||
| 
 |  | ||||||
| hledger_journal(5), hledger_csv(5), hledger_timeclock(5), hledger_timedot(5) |  | ||||||
|  | |||||||
| @ -6,8 +6,8 @@ File: hledger.info,  Node: Top,  Next: OPTIONS,  Up: (dir) | |||||||
| hledger(1) | hledger(1) | ||||||
| ********** | ********** | ||||||
| 
 | 
 | ||||||
| A command-line accounting tool for both power users and folks new to | hledger is a command-line accounting tool for both power users and folks | ||||||
| accounting. | new to accounting.  This manual is for hledger 1.20.99. | ||||||
| 
 | 
 | ||||||
|    'hledger' |    'hledger' | ||||||
| 
 | 
 | ||||||
| @ -7846,425 +7846,425 @@ $ LANG=en_US.UTF-8 hledger -f my.journal print | |||||||
|  |  | ||||||
| Tag Table: | Tag Table: | ||||||
| Node: Top68 | Node: Top68 | ||||||
| Node: OPTIONS2488 | Node: OPTIONS2536 | ||||||
| Ref: #options2589 | Ref: #options2637 | ||||||
| Node: General options2731 | Node: General options2779 | ||||||
| Ref: #general-options2856 | Ref: #general-options2904 | ||||||
| Node: Command options6257 | Node: Command options6305 | ||||||
| Ref: #command-options6408 | Ref: #command-options6456 | ||||||
| Node: Command arguments6808 | Node: Command arguments6856 | ||||||
| Ref: #command-arguments6966 | Ref: #command-arguments7014 | ||||||
| Node: Special characters7846 | Node: Special characters7894 | ||||||
| Ref: #special-characters8009 | Ref: #special-characters8057 | ||||||
| Node: Single escaping shell metacharacters8172 | Node: Single escaping shell metacharacters8220 | ||||||
| Ref: #single-escaping-shell-metacharacters8413 | Ref: #single-escaping-shell-metacharacters8461 | ||||||
| Node: Double escaping regular expression metacharacters8814 | Node: Double escaping regular expression metacharacters8862 | ||||||
| Ref: #double-escaping-regular-expression-metacharacters9125 | Ref: #double-escaping-regular-expression-metacharacters9173 | ||||||
| Node: Triple escaping for add-on commands9651 | Node: Triple escaping for add-on commands9699 | ||||||
| Ref: #triple-escaping-for-add-on-commands9911 | Ref: #triple-escaping-for-add-on-commands9959 | ||||||
| Node: Less escaping10555 | Node: Less escaping10603 | ||||||
| Ref: #less-escaping10709 | Ref: #less-escaping10757 | ||||||
| Node: Unicode characters11033 | Node: Unicode characters11081 | ||||||
| Ref: #unicode-characters11198 | Ref: #unicode-characters11246 | ||||||
| Node: Regular expressions12610 | Node: Regular expressions12658 | ||||||
| Ref: #regular-expressions12750 | Ref: #regular-expressions12798 | ||||||
| Node: ENVIRONMENT14486 | Node: ENVIRONMENT14534 | ||||||
| Ref: #environment14602 | Ref: #environment14650 | ||||||
| Node: DATA FILES15587 | Node: DATA FILES15635 | ||||||
| Ref: #data-files15706 | Ref: #data-files15754 | ||||||
| Node: Data formats16245 | Node: Data formats16293 | ||||||
| Ref: #data-formats16363 | Ref: #data-formats16411 | ||||||
| Node: Multiple files17700 | Node: Multiple files17748 | ||||||
| Ref: #multiple-files17842 | Ref: #multiple-files17890 | ||||||
| Node: Strict mode18311 | Node: Strict mode18359 | ||||||
| Ref: #strict-mode18426 | Ref: #strict-mode18474 | ||||||
| Node: TIME PERIODS19074 | Node: TIME PERIODS19122 | ||||||
| Ref: #time-periods19191 | Ref: #time-periods19239 | ||||||
| Node: Smart dates19289 | Node: Smart dates19337 | ||||||
| Ref: #smart-dates19415 | Ref: #smart-dates19463 | ||||||
| Node: Report start & end date20741 | Node: Report start & end date20789 | ||||||
| Ref: #report-start-end-date20916 | Ref: #report-start-end-date20964 | ||||||
| Node: Report intervals22449 | Node: Report intervals22497 | ||||||
| Ref: #report-intervals22617 | Ref: #report-intervals22665 | ||||||
| Node: Period expressions23007 | Node: Period expressions23055 | ||||||
| Ref: #period-expressions23147 | Ref: #period-expressions23195 | ||||||
| Node: DEPTH27590 | Node: DEPTH27638 | ||||||
| Ref: #depth27690 | Ref: #depth27738 | ||||||
| Node: QUERIES28022 | Node: QUERIES28070 | ||||||
| Ref: #queries28123 | Ref: #queries28171 | ||||||
| Node: VALUATION32085 | Node: VALUATION32133 | ||||||
| Ref: #valuation32193 | Ref: #valuation32241 | ||||||
| Node: -B Cost32882 | Node: -B Cost32930 | ||||||
| Ref: #b-cost32980 | Ref: #b-cost33028 | ||||||
| Node: -V Value33113 | Node: -V Value33161 | ||||||
| Ref: #v-value33253 | Ref: #v-value33301 | ||||||
| Node: -X Value in specified commodity33448 | Node: -X Value in specified commodity33496 | ||||||
| Ref: #x-value-in-specified-commodity33641 | Ref: #x-value-in-specified-commodity33689 | ||||||
| Node: Valuation date33790 | Node: Valuation date33838 | ||||||
| Ref: #valuation-date33952 | Ref: #valuation-date34000 | ||||||
| Node: Market prices34389 | Node: Market prices34437 | ||||||
| Ref: #market-prices34563 | Ref: #market-prices34611 | ||||||
| Node: --infer-value market prices from transactions35484 | Node: --infer-value market prices from transactions35532 | ||||||
| Ref: #infer-value-market-prices-from-transactions35727 | Ref: #infer-value-market-prices-from-transactions35775 | ||||||
| Node: Valuation commodity36988 | Node: Valuation commodity37036 | ||||||
| Ref: #valuation-commodity37191 | Ref: #valuation-commodity37239 | ||||||
| Node: Simple valuation examples38396 | Node: Simple valuation examples38444 | ||||||
| Ref: #simple-valuation-examples38592 | Ref: #simple-valuation-examples38640 | ||||||
| Node: --value Flexible valuation39251 | Node: --value Flexible valuation39299 | ||||||
| Ref: #value-flexible-valuation39453 | Ref: #value-flexible-valuation39501 | ||||||
| Node: More valuation examples41400 | Node: More valuation examples41448 | ||||||
| Ref: #more-valuation-examples41603 | Ref: #more-valuation-examples41651 | ||||||
| Node: Effect of valuation on reports43608 | Node: Effect of valuation on reports43656 | ||||||
| Ref: #effect-of-valuation-on-reports43790 | Ref: #effect-of-valuation-on-reports43838 | ||||||
| Node: PIVOTING50809 | Node: PIVOTING50857 | ||||||
| Ref: #pivoting50914 | Ref: #pivoting50962 | ||||||
| Node: OUTPUT52590 | Node: OUTPUT52638 | ||||||
| Ref: #output52690 | Ref: #output52738 | ||||||
| Node: Output destination52741 | Node: Output destination52789 | ||||||
| Ref: #output-destination52872 | Ref: #output-destination52920 | ||||||
| Node: Output format53297 | Node: Output format53345 | ||||||
| Ref: #output-format53418 | Ref: #output-format53466 | ||||||
| Node: COMMANDS55585 | Node: COMMANDS55633 | ||||||
| Ref: #commands55697 | Ref: #commands55745 | ||||||
| Node: accounts59062 | Node: accounts59110 | ||||||
| Ref: #accounts59162 | Ref: #accounts59210 | ||||||
| Node: activity59861 | Node: activity59909 | ||||||
| Ref: #activity59973 | Ref: #activity60021 | ||||||
| Node: add60356 | Node: add60404 | ||||||
| Ref: #add60459 | Ref: #add60507 | ||||||
| Node: aregister63252 | Node: aregister63300 | ||||||
| Ref: #aregister63366 | Ref: #aregister63414 | ||||||
| Node: aregister and custom posting dates64860 | Node: aregister and custom posting dates64908 | ||||||
| Ref: #aregister-and-custom-posting-dates65026 | Ref: #aregister-and-custom-posting-dates65074 | ||||||
| Node: balance65847 | Node: balance65895 | ||||||
| Ref: #balance65966 | Ref: #balance66014 | ||||||
| Node: Classic balance report67592 | Node: Classic balance report67640 | ||||||
| Ref: #classic-balance-report67767 | Ref: #classic-balance-report67815 | ||||||
| Node: Customising the classic balance report69091 | Node: Customising the classic balance report69139 | ||||||
| Ref: #customising-the-classic-balance-report69321 | Ref: #customising-the-classic-balance-report69369 | ||||||
| Node: Colour support71397 | Node: Colour support71445 | ||||||
| Ref: #colour-support71566 | Ref: #colour-support71614 | ||||||
| Node: Flat mode71662 | Node: Flat mode71710 | ||||||
| Ref: #flat-mode71812 | Ref: #flat-mode71860 | ||||||
| Node: Depth limited balance reports72225 | Node: Depth limited balance reports72273 | ||||||
| Ref: #depth-limited-balance-reports72412 | Ref: #depth-limited-balance-reports72460 | ||||||
| Node: Percentages72868 | Node: Percentages72916 | ||||||
| Ref: #percentages73027 | Ref: #percentages73075 | ||||||
| Node: Sorting by amount74164 | Node: Sorting by amount74212 | ||||||
| Ref: #sorting-by-amount74332 | Ref: #sorting-by-amount74380 | ||||||
| Node: Multicolumn balance report74826 | Node: Multicolumn balance report74874 | ||||||
| Ref: #multicolumn-balance-report75014 | Ref: #multicolumn-balance-report75062 | ||||||
| Node: Budget report80611 | Node: Budget report80659 | ||||||
| Ref: #budget-report80747 | Ref: #budget-report80795 | ||||||
| Node: Budget report start date86036 | Node: Budget report start date86084 | ||||||
| Ref: #budget-report-start-date86203 | Ref: #budget-report-start-date86251 | ||||||
| Node: Nested budgets87535 | Node: Nested budgets87583 | ||||||
| Ref: #nested-budgets87682 | Ref: #nested-budgets87730 | ||||||
| Node: balancesheet91122 | Node: balancesheet91170 | ||||||
| Ref: #balancesheet91260 | Ref: #balancesheet91308 | ||||||
| Node: balancesheetequity92897 | Node: balancesheetequity92945 | ||||||
| Ref: #balancesheetequity93048 | Ref: #balancesheetequity93096 | ||||||
| Node: cashflow94267 | Node: cashflow94315 | ||||||
| Ref: #cashflow94391 | Ref: #cashflow94439 | ||||||
| Node: check95725 | Node: check95773 | ||||||
| Ref: #check95830 | Ref: #check95878 | ||||||
| Node: Basic checks96435 | Node: Basic checks96483 | ||||||
| Ref: #basic-checks96553 | Ref: #basic-checks96601 | ||||||
| Node: Strict checks97046 | Node: Strict checks97094 | ||||||
| Ref: #strict-checks97187 | Ref: #strict-checks97235 | ||||||
| Node: Other checks97430 | Node: Other checks97478 | ||||||
| Ref: #other-checks97570 | Ref: #other-checks97618 | ||||||
| Node: Add-on checks97868 | Node: Add-on checks97916 | ||||||
| Ref: #add-on-checks97988 | Ref: #add-on-checks98036 | ||||||
| Node: close98441 | Node: close98489 | ||||||
| Ref: #close98545 | Ref: #close98593 | ||||||
| Node: close usage100067 | Node: close usage100115 | ||||||
| Ref: #close-usage100162 | Ref: #close-usage100210 | ||||||
| Node: codes102975 | Node: codes103023 | ||||||
| Ref: #codes103085 | Ref: #codes103133 | ||||||
| Node: commodities103797 | Node: commodities103845 | ||||||
| Ref: #commodities103926 | Ref: #commodities103974 | ||||||
| Node: descriptions104008 | Node: descriptions104056 | ||||||
| Ref: #descriptions104138 | Ref: #descriptions104186 | ||||||
| Node: diff104442 | Node: diff104490 | ||||||
| Ref: #diff104550 | Ref: #diff104598 | ||||||
| Node: files105597 | Node: files105645 | ||||||
| Ref: #files105699 | Ref: #files105747 | ||||||
| Node: help105846 | Node: help105894 | ||||||
| Ref: #help105948 | Ref: #help105996 | ||||||
| Node: import106999 | Node: import107047 | ||||||
| Ref: #import107115 | Ref: #import107163 | ||||||
| Node: Importing balance assignments108037 | Node: Importing balance assignments108085 | ||||||
| Ref: #importing-balance-assignments108220 | Ref: #importing-balance-assignments108268 | ||||||
| Node: Commodity display styles108869 | Node: Commodity display styles108917 | ||||||
| Ref: #commodity-display-styles109042 | Ref: #commodity-display-styles109090 | ||||||
| Node: incomestatement109171 | Node: incomestatement109219 | ||||||
| Ref: #incomestatement109306 | Ref: #incomestatement109354 | ||||||
| Node: notes110768 | Node: notes110816 | ||||||
| Ref: #notes110883 | Ref: #notes110931 | ||||||
| Node: payees111251 | Node: payees111299 | ||||||
| Ref: #payees111359 | Ref: #payees111407 | ||||||
| Node: prices111779 | Node: prices111827 | ||||||
| Ref: #prices111887 | Ref: #prices111935 | ||||||
| Node: print112228 | Node: print112276 | ||||||
| Ref: #print112340 | Ref: #print112388 | ||||||
| Node: print-unique117136 | Node: print-unique117184 | ||||||
| Ref: #print-unique117264 | Ref: #print-unique117312 | ||||||
| Node: register117549 | Node: register117597 | ||||||
| Ref: #register117678 | Ref: #register117726 | ||||||
| Node: Custom register output122127 | Node: Custom register output122175 | ||||||
| Ref: #custom-register-output122258 | Ref: #custom-register-output122306 | ||||||
| Node: register-match123595 | Node: register-match123643 | ||||||
| Ref: #register-match123731 | Ref: #register-match123779 | ||||||
| Node: rewrite124082 | Node: rewrite124130 | ||||||
| Ref: #rewrite124199 | Ref: #rewrite124247 | ||||||
| Node: Re-write rules in a file126105 | Node: Re-write rules in a file126153 | ||||||
| Ref: #re-write-rules-in-a-file126268 | Ref: #re-write-rules-in-a-file126316 | ||||||
| Node: Diff output format127417 | Node: Diff output format127465 | ||||||
| Ref: #diff-output-format127600 | Ref: #diff-output-format127648 | ||||||
| Node: rewrite vs print --auto128692 | Node: rewrite vs print --auto128740 | ||||||
| Ref: #rewrite-vs.-print---auto128852 | Ref: #rewrite-vs.-print---auto128900 | ||||||
| Node: roi129408 | Node: roi129456 | ||||||
| Ref: #roi129508 | Ref: #roi129556 | ||||||
| Node: stats141718 | Node: stats141766 | ||||||
| Ref: #stats141819 | Ref: #stats141867 | ||||||
| Node: tags142607 | Node: tags142655 | ||||||
| Ref: #tags142707 | Ref: #tags142755 | ||||||
| Node: test143226 | Node: test143274 | ||||||
| Ref: #test143342 | Ref: #test143390 | ||||||
| Node: About add-on commands144089 | Node: About add-on commands144137 | ||||||
| Ref: #about-add-on-commands144226 | Ref: #about-add-on-commands144274 | ||||||
| Node: JOURNAL FORMAT145500 | Node: JOURNAL FORMAT145548 | ||||||
| Ref: #journal-format145628 | Ref: #journal-format145676 | ||||||
| Node: Transactions147794 | Node: Transactions147842 | ||||||
| Ref: #transactions147909 | Ref: #transactions147957 | ||||||
| Node: Dates148923 | Node: Dates148971 | ||||||
| Ref: #dates149039 | Ref: #dates149087 | ||||||
| Node: Simple dates149104 | Node: Simple dates149152 | ||||||
| Ref: #simple-dates149224 | Ref: #simple-dates149272 | ||||||
| Node: Secondary dates149733 | Node: Secondary dates149781 | ||||||
| Ref: #secondary-dates149881 | Ref: #secondary-dates149929 | ||||||
| Node: Posting dates151217 | Node: Posting dates151265 | ||||||
| Ref: #posting-dates151340 | Ref: #posting-dates151388 | ||||||
| Node: Status152712 | Node: Status152760 | ||||||
| Ref: #status152829 | Ref: #status152877 | ||||||
| Node: Description154537 | Node: Description154585 | ||||||
| Ref: #description154667 | Ref: #description154715 | ||||||
| Node: Payee and note154987 | Node: Payee and note155035 | ||||||
| Ref: #payee-and-note155095 | Ref: #payee-and-note155143 | ||||||
| Node: Comments155430 | Node: Comments155478 | ||||||
| Ref: #comments155552 | Ref: #comments155600 | ||||||
| Node: Tags156746 | Node: Tags156794 | ||||||
| Ref: #tags-1156857 | Ref: #tags-1156905 | ||||||
| Node: Postings158250 | Node: Postings158298 | ||||||
| Ref: #postings158374 | Ref: #postings158422 | ||||||
| Node: Virtual postings159400 | Node: Virtual postings159448 | ||||||
| Ref: #virtual-postings159511 | Ref: #virtual-postings159559 | ||||||
| Node: Account names160816 | Node: Account names160864 | ||||||
| Ref: #account-names160953 | Ref: #account-names161001 | ||||||
| Node: Amounts161440 | Node: Amounts161488 | ||||||
| Ref: #amounts161575 | Ref: #amounts161623 | ||||||
| Node: Digit group marks162699 | Node: Digit group marks162747 | ||||||
| Ref: #digit-group-marks162844 | Ref: #digit-group-marks162892 | ||||||
| Node: Commodity display style163782 | Node: Commodity display style163830 | ||||||
| Ref: #commodity-display-style163956 | Ref: #commodity-display-style164004 | ||||||
| Node: Rounding165669 | Node: Rounding165717 | ||||||
| Ref: #rounding165787 | Ref: #rounding165835 | ||||||
| Node: Transaction prices166199 | Node: Transaction prices166247 | ||||||
| Ref: #transaction-prices166365 | Ref: #transaction-prices166413 | ||||||
| Node: Lot prices lot dates168796 | Node: Lot prices lot dates168844 | ||||||
| Ref: #lot-prices-lot-dates168979 | Ref: #lot-prices-lot-dates169027 | ||||||
| Node: Balance assertions169467 | Node: Balance assertions169515 | ||||||
| Ref: #balance-assertions169645 | Ref: #balance-assertions169693 | ||||||
| Node: Assertions and ordering170678 | Node: Assertions and ordering170726 | ||||||
| Ref: #assertions-and-ordering170860 | Ref: #assertions-and-ordering170908 | ||||||
| Node: Assertions and included files171560 | Node: Assertions and included files171608 | ||||||
| Ref: #assertions-and-included-files171797 | Ref: #assertions-and-included-files171845 | ||||||
| Node: Assertions and multiple -f options172130 | Node: Assertions and multiple -f options172178 | ||||||
| Ref: #assertions-and-multiple--f-options172380 | Ref: #assertions-and-multiple--f-options172428 | ||||||
| Node: Assertions and commodities172512 | Node: Assertions and commodities172560 | ||||||
| Ref: #assertions-and-commodities172738 | Ref: #assertions-and-commodities172786 | ||||||
| Node: Assertions and prices173895 | Node: Assertions and prices173943 | ||||||
| Ref: #assertions-and-prices174103 | Ref: #assertions-and-prices174151 | ||||||
| Node: Assertions and subaccounts174543 | Node: Assertions and subaccounts174591 | ||||||
| Ref: #assertions-and-subaccounts174766 | Ref: #assertions-and-subaccounts174814 | ||||||
| Node: Assertions and virtual postings175090 | Node: Assertions and virtual postings175138 | ||||||
| Ref: #assertions-and-virtual-postings175326 | Ref: #assertions-and-virtual-postings175374 | ||||||
| Node: Assertions and precision175468 | Node: Assertions and precision175516 | ||||||
| Ref: #assertions-and-precision175655 | Ref: #assertions-and-precision175703 | ||||||
| Node: Balance assignments175922 | Node: Balance assignments175970 | ||||||
| Ref: #balance-assignments176092 | Ref: #balance-assignments176140 | ||||||
| Node: Balance assignments and prices177256 | Node: Balance assignments and prices177304 | ||||||
| Ref: #balance-assignments-and-prices177422 | Ref: #balance-assignments-and-prices177470 | ||||||
| Node: Directives177646 | Node: Directives177694 | ||||||
| Ref: #directives177809 | Ref: #directives177857 | ||||||
| Node: Directives and multiple files183052 | Node: Directives and multiple files183100 | ||||||
| Ref: #directives-and-multiple-files183248 | Ref: #directives-and-multiple-files183296 | ||||||
| Node: Comment blocks183912 | Node: Comment blocks183960 | ||||||
| Ref: #comment-blocks184089 | Ref: #comment-blocks184137 | ||||||
| Node: Including other files184265 | Node: Including other files184313 | ||||||
| Ref: #including-other-files184439 | Ref: #including-other-files184487 | ||||||
| Node: Default year185363 | Node: Default year185411 | ||||||
| Ref: #default-year185526 | Ref: #default-year185574 | ||||||
| Node: Declaring commodities185933 | Node: Declaring commodities185981 | ||||||
| Ref: #declaring-commodities186110 | Ref: #declaring-commodities186158 | ||||||
| Node: Commodity error checking187954 | Node: Commodity error checking188002 | ||||||
| Ref: #commodity-error-checking188104 | Ref: #commodity-error-checking188152 | ||||||
| Node: Default commodity188361 | Node: Default commodity188409 | ||||||
| Ref: #default-commodity188541 | Ref: #default-commodity188589 | ||||||
| Node: Declaring market prices189430 | Node: Declaring market prices189478 | ||||||
| Ref: #declaring-market-prices189619 | Ref: #declaring-market-prices189667 | ||||||
| Node: Declaring accounts190476 | Node: Declaring accounts190524 | ||||||
| Ref: #declaring-accounts190656 | Ref: #declaring-accounts190704 | ||||||
| Node: Account error checking191858 | Node: Account error checking191906 | ||||||
| Ref: #account-error-checking192024 | Ref: #account-error-checking192072 | ||||||
| Node: Account comments193203 | Node: Account comments193251 | ||||||
| Ref: #account-comments193387 | Ref: #account-comments193435 | ||||||
| Node: Account subdirectives193811 | Node: Account subdirectives193859 | ||||||
| Ref: #account-subdirectives193996 | Ref: #account-subdirectives194044 | ||||||
| Node: Account types194309 | Node: Account types194357 | ||||||
| Ref: #account-types194483 | Ref: #account-types194531 | ||||||
| Node: Declaring account types195219 | Node: Declaring account types195267 | ||||||
| Ref: #declaring-account-types195398 | Ref: #declaring-account-types195446 | ||||||
| Node: Auto-detected account types196048 | Node: Auto-detected account types196096 | ||||||
| Ref: #auto-detected-account-types196289 | Ref: #auto-detected-account-types196337 | ||||||
| Node: Interference from auto-detected account types197186 | Node: Interference from auto-detected account types197234 | ||||||
| Ref: #interference-from-auto-detected-account-types197463 | Ref: #interference-from-auto-detected-account-types197511 | ||||||
| Node: Old account type syntax197946 | Node: Old account type syntax197994 | ||||||
| Ref: #old-account-type-syntax198143 | Ref: #old-account-type-syntax198191 | ||||||
| Node: Account display order198443 | Node: Account display order198491 | ||||||
| Ref: #account-display-order198603 | Ref: #account-display-order198651 | ||||||
| Node: Rewriting accounts199754 | Node: Rewriting accounts199802 | ||||||
| Ref: #rewriting-accounts199933 | Ref: #rewriting-accounts199981 | ||||||
| Node: Basic aliases200690 | Node: Basic aliases200738 | ||||||
| Ref: #basic-aliases200826 | Ref: #basic-aliases200874 | ||||||
| Node: Regex aliases201530 | Node: Regex aliases201578 | ||||||
| Ref: #regex-aliases201692 | Ref: #regex-aliases201740 | ||||||
| Node: Combining aliases202411 | Node: Combining aliases202459 | ||||||
| Ref: #combining-aliases202594 | Ref: #combining-aliases202642 | ||||||
| Node: Aliases and multiple files203870 | Node: Aliases and multiple files203918 | ||||||
| Ref: #aliases-and-multiple-files204069 | Ref: #aliases-and-multiple-files204117 | ||||||
| Node: end aliases204648 | Node: end aliases204696 | ||||||
| Ref: #end-aliases204795 | Ref: #end-aliases204843 | ||||||
| Node: Default parent account204896 | Node: Default parent account204944 | ||||||
| Ref: #default-parent-account205086 | Ref: #default-parent-account205134 | ||||||
| Node: Periodic transactions205970 | Node: Periodic transactions206018 | ||||||
| Ref: #periodic-transactions206153 | Ref: #periodic-transactions206201 | ||||||
| Node: Periodic rule syntax208070 | Node: Periodic rule syntax208118 | ||||||
| Ref: #periodic-rule-syntax208270 | Ref: #periodic-rule-syntax208318 | ||||||
| Node: Two spaces between period expression and description!208974 | Node: Two spaces between period expression and description!209022 | ||||||
| Ref: #two-spaces-between-period-expression-and-description209287 | Ref: #two-spaces-between-period-expression-and-description209335 | ||||||
| Node: Forecasting with periodic transactions209971 | Node: Forecasting with periodic transactions210019 | ||||||
| Ref: #forecasting-with-periodic-transactions210270 | Ref: #forecasting-with-periodic-transactions210318 | ||||||
| Node: Budgeting with periodic transactions212325 | Node: Budgeting with periodic transactions212373 | ||||||
| Ref: #budgeting-with-periodic-transactions212558 | Ref: #budgeting-with-periodic-transactions212606 | ||||||
| Node: Auto postings212967 | Node: Auto postings213015 | ||||||
| Ref: #auto-postings213103 | Ref: #auto-postings213151 | ||||||
| Node: Auto postings and multiple files215282 | Node: Auto postings and multiple files215330 | ||||||
| Ref: #auto-postings-and-multiple-files215480 | Ref: #auto-postings-and-multiple-files215528 | ||||||
| Node: Auto postings and dates215689 | Node: Auto postings and dates215737 | ||||||
| Ref: #auto-postings-and-dates215957 | Ref: #auto-postings-and-dates216005 | ||||||
| Node: Auto postings and transaction balancing / inferred amounts / balance assertions216132 | Node: Auto postings and transaction balancing / inferred amounts / balance assertions216180 | ||||||
| Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions216477 | Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions216525 | ||||||
| Node: Auto posting tags216819 | Node: Auto posting tags216867 | ||||||
| Ref: #auto-posting-tags217028 | Ref: #auto-posting-tags217076 | ||||||
| Node: CSV FORMAT217664 | Node: CSV FORMAT217712 | ||||||
| Ref: #csv-format217792 | Ref: #csv-format217840 | ||||||
| Node: Examples220378 | Node: Examples220426 | ||||||
| Ref: #examples220481 | Ref: #examples220529 | ||||||
| Node: Basic220689 | Node: Basic220737 | ||||||
| Ref: #basic220791 | Ref: #basic220839 | ||||||
| Node: Bank of Ireland221333 | Node: Bank of Ireland221381 | ||||||
| Ref: #bank-of-ireland221470 | Ref: #bank-of-ireland221518 | ||||||
| Node: Amazon222932 | Node: Amazon222980 | ||||||
| Ref: #amazon223052 | Ref: #amazon223100 | ||||||
| Node: Paypal224771 | Node: Paypal224819 | ||||||
| Ref: #paypal224867 | Ref: #paypal224915 | ||||||
| Node: CSV rules232511 | Node: CSV rules232559 | ||||||
| Ref: #csv-rules232629 | Ref: #csv-rules232677 | ||||||
| Node: skip232941 | Node: skip232989 | ||||||
| Ref: #skip233036 | Ref: #skip233084 | ||||||
| Node: fields233411 | Node: fields233459 | ||||||
| Ref: #fields233535 | Ref: #fields233583 | ||||||
| Node: Transaction field names234700 | Node: Transaction field names234748 | ||||||
| Ref: #transaction-field-names234862 | Ref: #transaction-field-names234910 | ||||||
| Node: Posting field names234973 | Node: Posting field names235021 | ||||||
| Ref: #posting-field-names235127 | Ref: #posting-field-names235175 | ||||||
| Node: field assignment237497 | Node: field assignment237545 | ||||||
| Ref: #field-assignment237642 | Ref: #field-assignment237690 | ||||||
| Node: separator238460 | Node: separator238508 | ||||||
| Ref: #separator238597 | Ref: #separator238645 | ||||||
| Node: if block239137 | Node: if block239185 | ||||||
| Ref: #if-block239264 | Ref: #if-block239312 | ||||||
| Node: Matching the whole record239665 | Node: Matching the whole record239713 | ||||||
| Ref: #matching-the-whole-record239842 | Ref: #matching-the-whole-record239890 | ||||||
| Node: Matching individual fields240646 | Node: Matching individual fields240694 | ||||||
| Ref: #matching-individual-fields240852 | Ref: #matching-individual-fields240900 | ||||||
| Node: Combining matchers241076 | Node: Combining matchers241124 | ||||||
| Ref: #combining-matchers241274 | Ref: #combining-matchers241322 | ||||||
| Node: Rules applied on successful match241587 | Node: Rules applied on successful match241635 | ||||||
| Ref: #rules-applied-on-successful-match241780 | Ref: #rules-applied-on-successful-match241828 | ||||||
| Node: if table242434 | Node: if table242482 | ||||||
| Ref: #if-table242555 | Ref: #if-table242603 | ||||||
| Node: end244293 | Node: end244341 | ||||||
| Ref: #end244407 | Ref: #end244455 | ||||||
| Node: date-format244631 | Node: date-format244679 | ||||||
| Ref: #date-format244765 | Ref: #date-format244813 | ||||||
| Node: decimal-mark245514 | Node: decimal-mark245562 | ||||||
| Ref: #decimal-mark245659 | Ref: #decimal-mark245707 | ||||||
| Node: newest-first245998 | Node: newest-first246046 | ||||||
| Ref: #newest-first246141 | Ref: #newest-first246189 | ||||||
| Node: include246824 | Node: include246872 | ||||||
| Ref: #include246957 | Ref: #include247005 | ||||||
| Node: balance-type247401 | Node: balance-type247449 | ||||||
| Ref: #balance-type247523 | Ref: #balance-type247571 | ||||||
| Node: Tips248223 | Node: Tips248271 | ||||||
| Ref: #tips248314 | Ref: #tips248362 | ||||||
| Node: Rapid feedback248570 | Node: Rapid feedback248618 | ||||||
| Ref: #rapid-feedback248689 | Ref: #rapid-feedback248737 | ||||||
| Node: Valid CSV249149 | Node: Valid CSV249197 | ||||||
| Ref: #valid-csv249281 | Ref: #valid-csv249329 | ||||||
| Node: File Extension249473 | Node: File Extension249521 | ||||||
| Ref: #file-extension249627 | Ref: #file-extension249675 | ||||||
| Node: Reading multiple CSV files250056 | Node: Reading multiple CSV files250104 | ||||||
| Ref: #reading-multiple-csv-files250243 | Ref: #reading-multiple-csv-files250291 | ||||||
| Node: Valid transactions250484 | Node: Valid transactions250532 | ||||||
| Ref: #valid-transactions250664 | Ref: #valid-transactions250712 | ||||||
| Node: Deduplicating importing251292 | Node: Deduplicating importing251340 | ||||||
| Ref: #deduplicating-importing251473 | Ref: #deduplicating-importing251521 | ||||||
| Node: Setting amounts252506 | Node: Setting amounts252554 | ||||||
| Ref: #setting-amounts252677 | Ref: #setting-amounts252725 | ||||||
| Node: Setting currency/commodity253664 | Node: Setting currency/commodity253712 | ||||||
| Ref: #setting-currencycommodity253858 | Ref: #setting-currencycommodity253906 | ||||||
| Node: Referencing other fields255032 | Node: Referencing other fields255080 | ||||||
| Ref: #referencing-other-fields255234 | Ref: #referencing-other-fields255282 | ||||||
| Node: How CSV rules are evaluated256131 | Node: How CSV rules are evaluated256179 | ||||||
| Ref: #how-csv-rules-are-evaluated256306 | Ref: #how-csv-rules-are-evaluated256354 | ||||||
| Node: TIMECLOCK FORMAT257757 | Node: TIMECLOCK FORMAT257805 | ||||||
| Ref: #timeclock-format257897 | Ref: #timeclock-format257945 | ||||||
| Node: TIMEDOT FORMAT259958 | Node: TIMEDOT FORMAT260006 | ||||||
| Ref: #timedot-format260096 | Ref: #timedot-format260144 | ||||||
| Node: COMMON TASKS264372 | Node: COMMON TASKS264420 | ||||||
| Ref: #common-tasks264501 | Ref: #common-tasks264549 | ||||||
| Node: Getting help264908 | Node: Getting help264956 | ||||||
| Ref: #getting-help265042 | Ref: #getting-help265090 | ||||||
| Node: Constructing command lines265595 | Node: Constructing command lines265643 | ||||||
| Ref: #constructing-command-lines265789 | Ref: #constructing-command-lines265837 | ||||||
| Node: Starting a journal file266486 | Node: Starting a journal file266534 | ||||||
| Ref: #starting-a-journal-file266686 | Ref: #starting-a-journal-file266734 | ||||||
| Node: Setting opening balances267874 | Node: Setting opening balances267922 | ||||||
| Ref: #setting-opening-balances268072 | Ref: #setting-opening-balances268120 | ||||||
| Node: Recording transactions271213 | Node: Recording transactions271261 | ||||||
| Ref: #recording-transactions271395 | Ref: #recording-transactions271443 | ||||||
| Node: Reconciling271951 | Node: Reconciling271999 | ||||||
| Ref: #reconciling272096 | Ref: #reconciling272144 | ||||||
| Node: Reporting274353 | Node: Reporting274401 | ||||||
| Ref: #reporting274495 | Ref: #reporting274543 | ||||||
| Node: Migrating to a new file278494 | Node: Migrating to a new file278542 | ||||||
| Ref: #migrating-to-a-new-file278644 | Ref: #migrating-to-a-new-file278692 | ||||||
| Node: LIMITATIONS278943 | Node: LIMITATIONS278991 | ||||||
| Ref: #limitations279071 | Ref: #limitations279119 | ||||||
| Node: TROUBLESHOOTING279814 | Node: TROUBLESHOOTING279862 | ||||||
| Ref: #troubleshooting279929 | Ref: #troubleshooting279977 | ||||||
|  |  | ||||||
| End Tag Table | End Tag Table | ||||||
|  | |||||||
| @ -4,8 +4,8 @@ HLEDGER(1)                   hledger User Manuals                   HLEDGER(1) | |||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| NAME | NAME | ||||||
|        A  command-line  accounting  tool for both power users and folks new to |        hledger  is  a  command-line  accounting  tool for both power users and | ||||||
|        accounting. |        folks new to accounting.  This manual is for hledger 1.20.99. | ||||||
| 
 | 
 | ||||||
| SYNOPSIS | SYNOPSIS | ||||||
|        hledger |        hledger | ||||||
| @ -6587,9 +6587,6 @@ COPYRIGHT | |||||||
| SEE ALSO | SEE ALSO | ||||||
|        hledger(1), hledger-ui(1), hledger-web(1), ledger(1) |        hledger(1), hledger-ui(1), hledger-web(1), ledger(1) | ||||||
| 
 | 
 | ||||||
|        hledger_journal(5), hledger_csv(5), hledger_timeclock(5), hledger_time- |  | ||||||
|        dot(5) |  | ||||||
| 
 |  | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| hledger-1.20.99                  December 2020                      HLEDGER(1) | hledger-1.20.99                  December 2020                      HLEDGER(1) | ||||||
|  | |||||||
		Loading…
	
		Reference in New Issue
	
	Block a user