ui: tweak -E help, hledger-ui shows zeroes by default
[ci skip]
This commit is contained in:
		
							parent
							
								
									8fb2479267
								
							
						
					
					
						commit
						a8933e8c5c
					
				| @ -147,7 +147,7 @@ m4_define({{_reportingoptions_}}, {{ | ||||
| : hide/aggregate accounts or postings more than NUM levels deep | ||||
| 
 | ||||
| `-E --empty` | ||||
| : show items with zero amount, normally hidden | ||||
| : show items with zero amount, normally hidden (except in hledger-ui) | ||||
| 
 | ||||
| `-B --cost` | ||||
| : convert amounts to their cost at transaction time | ||||
|  | ||||
| @ -172,7 +172,7 @@ hide/aggregate accounts or postings more than NUM levels deep | ||||
| .RE | ||||
| .TP | ||||
| .B \f[C]\-E\ \-\-empty\f[] | ||||
| show items with zero amount, normally hidden | ||||
| show items with zero amount, normally hidden (except in hledger\-ui) | ||||
| .RS | ||||
| .RE | ||||
| .TP | ||||
|  | ||||
| @ -122,7 +122,7 @@ the data. | ||||
|      hide/aggregate accounts or postings more than NUM levels deep | ||||
| '-E --empty' | ||||
| 
 | ||||
|      show items with zero amount, normally hidden | ||||
|      show items with zero amount, normally hidden (except in hledger-ui) | ||||
| '-B --cost' | ||||
| 
 | ||||
|      convert amounts to their cost at transaction time (using the | ||||
| @ -378,17 +378,17 @@ Tag Table: | ||||
| Node: Top71 | ||||
| Node: OPTIONS827 | ||||
| Ref: #options924 | ||||
| Node: KEYS4093 | ||||
| Ref: #keys4188 | ||||
| Node: SCREENS7147 | ||||
| Ref: #screens7232 | ||||
| Node: Accounts screen7322 | ||||
| Ref: #accounts-screen7450 | ||||
| Node: Register screen9680 | ||||
| Ref: #register-screen9835 | ||||
| Node: Transaction screen11909 | ||||
| Ref: #transaction-screen12067 | ||||
| Node: Error screen12937 | ||||
| Ref: #error-screen13059 | ||||
| Node: KEYS4116 | ||||
| Ref: #keys4211 | ||||
| Node: SCREENS7170 | ||||
| Ref: #screens7255 | ||||
| Node: Accounts screen7345 | ||||
| Ref: #accounts-screen7473 | ||||
| Node: Register screen9703 | ||||
| Ref: #register-screen9858 | ||||
| Node: Transaction screen11932 | ||||
| Ref: #transaction-screen12090 | ||||
| Node: Error screen12960 | ||||
| Ref: #error-screen13082 | ||||
|  | ||||
| End Tag Table | ||||
|  | ||||
| @ -118,20 +118,21 @@ OPTIONS | ||||
|               hide/aggregate accounts or postings more than NUM levels deep | ||||
| 
 | ||||
|        -E --empty | ||||
|               show items with zero amount, normally hidden | ||||
|               show   items  with  zero  amount,  normally  hidden  (except  in | ||||
|               hledger-ui) | ||||
| 
 | ||||
|        -B --cost | ||||
|               convert  amounts  to  their  cost at transaction time (using the | ||||
|               convert amounts to their cost at  transaction  time  (using  the | ||||
|               transaction price, if any) | ||||
| 
 | ||||
|        -V --value | ||||
|               convert amounts to their market value on  the  report  end  date | ||||
|               convert  amounts  to  their  market value on the report end date | ||||
|               (using the most recent applicable market price, if any) | ||||
| 
 | ||||
|        --auto apply automated posting rules to modify transactions. | ||||
| 
 | ||||
|        --forecast | ||||
|               apply  periodic  transaction  rules  to generate future transac- | ||||
|               apply periodic transaction rules  to  generate  future  transac- | ||||
|               tions, to 6 months from now or report end date. | ||||
| 
 | ||||
|        When a reporting option appears more than once in the command line, the | ||||
| @ -151,64 +152,64 @@ OPTIONS | ||||
|               show debug output (levels 1-9, default: 1) | ||||
| 
 | ||||
|        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.) | ||||
| 
 | ||||
| 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, | ||||
|        or LEFT) to close it.  The following keys work on most screens: | ||||
| 
 | ||||
|        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 | ||||
|        down    through    lists.     Vi-style    (h/j/k/l)   and   Emacs-style | ||||
|        the  previous  screen,  up/down/page up/page down/home/end  move up and | ||||
|        down   through   lists.     Vi-style    (h/j/k/l)    and    Emacs-style | ||||
|        (CTRL-p/CTRL-n/CTRL-f/CTRL-b) movement keys are also supported.  A tip: | ||||
|        movement  speed is limited by your keyboard repeat rate, to move faster | ||||
|        you may want to adjust it.  (If you're on a mac, the Karabiner  app  is | ||||
|        movement speed is limited by your keyboard repeat rate, to move  faster | ||||
|        you  may  want to adjust it.  (If you're on a mac, the Karabiner app is | ||||
|        one way to do that.) | ||||
| 
 | ||||
|        With  shift pressed, the cursor keys adjust the report period, limiting | ||||
|        the  transactions  to  be  shown   (by   default,   all   are   shown). | ||||
|        shift-down/up  steps  downward and upward through these standard report | ||||
|        With shift pressed, the cursor keys adjust the report period,  limiting | ||||
|        the   transactions   to   be   shown   (by  default,  all  are  shown). | ||||
|        shift-down/up steps downward and upward through these  standard  report | ||||
|        period   durations:   year,   quarter,   month,   week,   day.    Then, | ||||
|        shift-left/right  moves to the previous/next period.  t sets the report | ||||
|        period to today.  With the --watch option,  when  viewing  a  "current" | ||||
|        period  (the  current  day,  week, month, quarter, or year), the period | ||||
|        will move automatically to track the current date.  To set a  non-stan- | ||||
|        shift-left/right moves to the previous/next period.  t sets the  report | ||||
|        period  to  today.   With  the --watch option, when viewing a "current" | ||||
|        period (the current day, week, month, quarter,  or  year),  the  period | ||||
|        will  move automatically to track the current date.  To set a non-stan- | ||||
|        dard period, you can use / and a date: query. | ||||
| 
 | ||||
|        /  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 | ||||
|        query,  you  can  use CTRL-a/e/d/k, BS, cursor keys; press ENTER to set | ||||
|        / 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 | ||||
|        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 | ||||
|        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. | ||||
| 
 | ||||
|        ESCAPE removes all filters and jumps back to the top  screen.   Or,  it | ||||
|        ESCAPE  removes  all  filters and jumps back to the top screen.  Or, it | ||||
|        cancels a minibuffer edit or help dialog in progress. | ||||
| 
 | ||||
|        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). | ||||
| 
 | ||||
|        g  reloads from the data file(s) and updates the current screen and any | ||||
|        previous screens.  (With large files, this  could  cause  a  noticeable | ||||
|        g reloads from the data file(s) and updates the current screen and  any | ||||
|        previous  screens.   (With  large  files, this could cause a noticeable | ||||
|        pause.) | ||||
| 
 | ||||
|        I  toggles  balance  assertion  checking.  Disabling balance assertions | ||||
|        I toggles balance assertion  checking.   Disabling  balance  assertions | ||||
|        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. | ||||
| 
 | ||||
|        A  is  like  a,  but  runs  the  hledger-iadd  tool,  which  provides a | ||||
|        curses-style interface.  This key will be available if hledger-iadd  is | ||||
|        A is  like  a,  but  runs  the  hledger-iadd  tool,  which  provides  a | ||||
|        curses-style  interface.  This key will be available if hledger-iadd is | ||||
|        installed in $PATH. | ||||
| 
 | ||||
|        E   runs   $HLEDGER_UI_EDITOR,   or   $EDITOR,   or  a  default  (emac- | ||||
|        E  runs  $HLEDGER_UI_EDITOR,  or   $EDITOR,   or   a   default   (emac- | ||||
|        sclient -a "" -nw) on the journal file.  With some editors (emacs, vi), | ||||
|        the  cursor  will be positioned at the current transaction when invoked | ||||
|        from the register and transaction screens, and at  the  error  location | ||||
|        the cursor will be positioned at the current transaction  when  invoked | ||||
|        from  the  register  and transaction screens, and at the error location | ||||
|        (if possible) when invoked from the error screen. | ||||
| 
 | ||||
|        q quits the application. | ||||
| @ -217,44 +218,44 @@ KEYS | ||||
| 
 | ||||
| SCREENS | ||||
|    Accounts screen | ||||
|        This  is  normally  the  first screen displayed.  It lists accounts and | ||||
|        their balances, like hledger's balance command.  By default,  it  shows | ||||
|        all  accounts  and their latest ending balances (including the balances | ||||
|        of subaccounts).  if you specify a query on the command line, it  shows | ||||
|        This is normally the first screen displayed.   It  lists  accounts  and | ||||
|        their  balances,  like hledger's balance command.  By default, it shows | ||||
|        all accounts and their latest ending balances (including  the  balances | ||||
|        of  subaccounts).  if you specify a query on the command line, it shows | ||||
|        just the matched accounts and the balances from matched transactions. | ||||
| 
 | ||||
|        Account  names are normally indented to show the hierarchy (tree mode). | ||||
|        Account names are normally indented to show the hierarchy (tree  mode). | ||||
|        To see less detail, set a depth limit by pressing a number key, 1 to 9. | ||||
|        0 shows even less detail, collapsing all accounts to a single total.  - | ||||
|        and + (or =) decrease and increase the  depth  limit.   To  remove  the | ||||
|        depth  limit,  set  it  higher than the maximum account depth, or press | ||||
|        and  +  (or  =)  decrease  and increase the depth limit.  To remove the | ||||
|        depth limit, set it higher than the maximum  account  depth,  or  press | ||||
|        ESCAPE. | ||||
| 
 | ||||
|        F toggles flat mode, in which accounts are shown as a flat  list,  with | ||||
|        their  full names.  In this mode, account balances exclude subaccounts, | ||||
|        except for accounts at the depth limit (as with hledger's balance  com- | ||||
|        F  toggles  flat mode, in which accounts are shown as a flat list, with | ||||
|        their full names.  In this mode, account balances exclude  subaccounts, | ||||
|        except  for accounts at the depth limit (as with hledger's balance com- | ||||
|        mand). | ||||
| 
 | ||||
|        H toggles between showing historical balances or period balances.  His- | ||||
|        torical balances (the default) are ending balances at the  end  of  the | ||||
|        report  period,  taking  into account all transactions before that date | ||||
|        (filtered by the filter query if any),  including  transactions  before | ||||
|        the  start  of  the report period.  In other words, historical balances | ||||
|        are what you would see on a bank statement  for  that  account  (unless | ||||
|        disturbed  by  a  filter  query).   Period balances ignore transactions | ||||
|        torical  balances  (the  default) are ending balances at the end of the | ||||
|        report period, taking into account all transactions  before  that  date | ||||
|        (filtered  by  the  filter query if any), including transactions before | ||||
|        the start of the report period.  In other  words,  historical  balances | ||||
|        are  what  you  would  see on a bank statement for that account (unless | ||||
|        disturbed by a filter  query).   Period  balances  ignore  transactions | ||||
|        before the report start date, so they show the change in balance during | ||||
|        the report period.  They are more useful eg when viewing a time log. | ||||
| 
 | ||||
|        U toggles filtering by unmarked status, including or excluding unmarked | ||||
|        postings in the balances.  Similarly, P toggles pending postings, and C | ||||
|        toggles  cleared postings.  (By default, balances include all postings; | ||||
|        if you activate one or two status  filters,  only  those  postings  are | ||||
|        toggles cleared postings.  (By default, balances include all  postings; | ||||
|        if  you  activate  one  or  two status filters, only those postings are | ||||
|        included; and if you activate all three, the filter is removed.) | ||||
| 
 | ||||
|        R toggles real mode, in which virtual postings are ignored. | ||||
| 
 | ||||
|        Z  toggles  nonzero  mode, in which only accounts with nonzero balances | ||||
|        are shown (hledger-ui shows zero items by default, unlike  command-line | ||||
|        Z toggles nonzero mode, in which only accounts  with  nonzero  balances | ||||
|        are  shown (hledger-ui shows zero items by default, unlike command-line | ||||
|        hledger). | ||||
| 
 | ||||
|        Press right or enter to view an account's transactions register. | ||||
| @ -263,65 +264,65 @@ SCREENS | ||||
|        This screen shows the transactions affecting a particular account, like | ||||
|        a check register.  Each line represents one transaction and shows: | ||||
| 
 | ||||
|        o the other account(s) involved, in abbreviated form.   (If  there  are | ||||
|          both  real  and virtual postings, it shows only the accounts affected | ||||
|        o the  other  account(s)  involved, in abbreviated form.  (If there are | ||||
|          both real and virtual postings, it shows only the  accounts  affected | ||||
|          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. | ||||
| 
 | ||||
|        o the running historical total or period total for the current account, | ||||
|          after the transaction.  This can be toggled with H.  Similar  to  the | ||||
|          accounts  screen,  the  historical  total is affected by transactions | ||||
|          (filtered by the filter query) before the report  start  date,  while | ||||
|          after  the  transaction.  This can be toggled with H.  Similar to the | ||||
|          accounts screen, the historical total  is  affected  by  transactions | ||||
|          (filtered  by  the  filter query) before the report start date, while | ||||
|          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. | ||||
| 
 | ||||
|        If  the  accounts  screen  was  in  tree mode, the register screen will | ||||
|        If the accounts screen was in  tree  mode,  the  register  screen  will | ||||
|        include transactions from both the current account and its subaccounts. | ||||
|        If  the  accounts  screen  was  in  flat  mode, and a non-depth-clipped | ||||
|        account was selected, the register  screen  will  exclude  transactions | ||||
|        If the accounts screen  was  in  flat  mode,  and  a  non-depth-clipped | ||||
|        account  was  selected,  the  register screen will exclude transactions | ||||
|        from subaccounts.  In other words, the register always shows the trans- | ||||
|        actions responsible for  the  period  balance  shown  on  the  accounts | ||||
|        actions  responsible  for  the  period  balance  shown  on the accounts | ||||
|        screen.  As on the accounts screen, this can be toggled with F. | ||||
| 
 | ||||
|        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 | ||||
|        cleared  transactions.  (By default, transactions with all statuses are | ||||
|        shown; if you activate one or two status filters, only  those  transac- | ||||
|        tions  are  shown;  and  if  you  activate  all  three,  the  filter is | ||||
|        cleared transactions.  (By default, transactions with all statuses  are | ||||
|        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.)q | ||||
| 
 | ||||
|        R toggles real mode, in which virtual postings are ignored. | ||||
| 
 | ||||
|        Z toggles nonzero mode, in which only transactions  posting  a  nonzero | ||||
|        change  are  shown (hledger-ui shows zero items by default, unlike com- | ||||
|        Z  toggles  nonzero  mode, in which only transactions posting a nonzero | ||||
|        change are shown (hledger-ui shows zero items by default,  unlike  com- | ||||
|        mand-line hledger). | ||||
| 
 | ||||
|        Press right (or enter) to view the selected transaction in detail. | ||||
| 
 | ||||
|    Transaction screen | ||||
|        This screen shows a single transaction, as  a  general  journal  entry, | ||||
|        similar  to  hledger's  print command and journal format (hledger_jour- | ||||
|        This  screen  shows  a  single transaction, as a general journal entry, | ||||
|        similar to hledger's print command and  journal  format  (hledger_jour- | ||||
|        nal(5)). | ||||
| 
 | ||||
|        The transaction's date(s)  and  any  cleared  flag,  transaction  code, | ||||
|        description,  comments,  along  with  all  of  its account postings are | ||||
|        shown.  Simple transactions have two postings, but there  can  be  more | ||||
|        The  transaction's  date(s)  and  any  cleared  flag, transaction code, | ||||
|        description, comments, along with  all  of  its  account  postings  are | ||||
|        shown.   Simple  transactions  have two postings, but there can be more | ||||
|        (or in certain cases, fewer). | ||||
| 
 | ||||
|        up  and  down will step through all transactions listed in the previous | ||||
|        account register screen.  In the title bar, the numbers in  parentheses | ||||
|        show  your  position  within  that  account  register.   They will vary | ||||
|        up and down will step through all transactions listed in  the  previous | ||||
|        account  register screen.  In the title bar, the numbers in parentheses | ||||
|        show your position  within  that  account  register.   They  will  vary | ||||
|        depending on which account register you came from (remember most trans- | ||||
|        actions appear in multiple account registers).  The #N number preceding | ||||
|        them is the transaction's position within the complete unfiltered jour- | ||||
|        nal, which is a more stable id (at least until the next reload). | ||||
| 
 | ||||
|    Error screen | ||||
|        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 | ||||
|        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 | ||||
|        again to reload and resume normal operation.  (Or, you can press escape | ||||
|        to cancel the reload attempt.) | ||||
| 
 | ||||
| @ -329,17 +330,17 @@ ENVIRONMENT | ||||
|        COLUMNS The screen width to use.  Default: the full terminal width. | ||||
| 
 | ||||
|        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). | ||||
| 
 | ||||
| FILES | ||||
|        Reads data from one or more files in hledger journal, timeclock,  time- | ||||
|        dot,   or   CSV   format   specified   with  -f,  or  $LEDGER_FILE,  or | ||||
|        $HOME/.hledger.journal          (on          windows,           perhaps | ||||
|        Reads  data from one or more files in hledger journal, timeclock, time- | ||||
|        dot,  or  CSV  format  specified   with   -f,   or   $LEDGER_FILE,   or | ||||
|        $HOME/.hledger.journal           (on          windows,          perhaps | ||||
|        C:/Users/USER/.hledger.journal). | ||||
| 
 | ||||
| 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. | ||||
| 
 | ||||
|        -f- doesn't work (hledger-ui can't read from stdin). | ||||
| @ -347,13 +348,13 @@ BUGS | ||||
|        -V affects only the accounts screen. | ||||
| 
 | ||||
|        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. | ||||
| 
 | ||||
|        --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 | ||||
|        times with an editor macro) can cause problems at least on OSX.   Symp- | ||||
|        toms  include:  unresponsive UI, periodic resetting of the cursor posi- | ||||
|        --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 | ||||
|        times  with an editor macro) can cause problems at least on OSX.  Symp- | ||||
|        toms include: unresponsive UI, periodic resetting of the  cursor  posi- | ||||
|        tion, momentary display of parse errors, high CPU usage eventually sub- | ||||
|        siding, and possibly a small but persistent build-up of CPU usage until | ||||
|        the program is restarted. | ||||
| @ -361,7 +362,7 @@ 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) | ||||
| 
 | ||||
| 
 | ||||
| @ -375,7 +376,7 @@ COPYRIGHT | ||||
| 
 | ||||
| 
 | ||||
| SEE ALSO | ||||
|        hledger(1),      hledger-ui(1),     hledger-web(1),     hledger-api(1), | ||||
|        hledger(1),     hledger-ui(1),     hledger-web(1),      hledger-api(1), | ||||
|        hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time- | ||||
|        dot(5), ledger(1) | ||||
| 
 | ||||
|  | ||||
| @ -227,7 +227,7 @@ hide/aggregate accounts or postings more than NUM levels deep | ||||
| .RE | ||||
| .TP | ||||
| .B \f[C]\-E\ \-\-empty\f[] | ||||
| show items with zero amount, normally hidden | ||||
| show items with zero amount, normally hidden (except in hledger\-ui) | ||||
| .RS | ||||
| .RE | ||||
| .TP | ||||
|  | ||||
| @ -167,7 +167,7 @@ options as shown above. | ||||
|      hide/aggregate accounts or postings more than NUM levels deep | ||||
| '-E --empty' | ||||
| 
 | ||||
|      show items with zero amount, normally hidden | ||||
|      show items with zero amount, normally hidden (except in hledger-ui) | ||||
| '-B --cost' | ||||
| 
 | ||||
|      convert amounts to their cost at transaction time (using the | ||||
|  | ||||
| @ -163,20 +163,21 @@ OPTIONS | ||||
|               hide/aggregate accounts or postings more than NUM levels deep | ||||
| 
 | ||||
|        -E --empty | ||||
|               show items with zero amount, normally hidden | ||||
|               show  items  with  zero  amount,  normally  hidden  (except   in | ||||
|               hledger-ui) | ||||
| 
 | ||||
|        -B --cost | ||||
|               convert amounts to their cost at  transaction  time  (using  the | ||||
|               convert  amounts  to  their  cost at transaction time (using the | ||||
|               transaction price, if any) | ||||
| 
 | ||||
|        -V --value | ||||
|               convert  amounts  to  their  market value on the report end date | ||||
|               convert amounts to their market value on  the  report  end  date | ||||
|               (using the most recent applicable market price, if any) | ||||
| 
 | ||||
|        --auto apply automated posting rules to modify transactions. | ||||
| 
 | ||||
|        --forecast | ||||
|               apply periodic transaction rules  to  generate  future  transac- | ||||
|               apply  periodic  transaction  rules  to generate future transac- | ||||
|               tions, to 6 months from now or report end date. | ||||
| 
 | ||||
|        When a reporting option appears more than once in the command line, the | ||||
| @ -196,22 +197,22 @@ OPTIONS | ||||
|               show debug output (levels 1-9, default: 1) | ||||
| 
 | ||||
|        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.) | ||||
| 
 | ||||
| ENVIRONMENT | ||||
|        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). | ||||
| 
 | ||||
| FILES | ||||
|        Reads data from one or more files in hledger journal, timeclock,  time- | ||||
|        dot,   or   CSV   format   specified   with  -f,  or  $LEDGER_FILE,  or | ||||
|        $HOME/.hledger.journal          (on          windows,           perhaps | ||||
|        Reads  data from one or more files in hledger journal, timeclock, time- | ||||
|        dot,  or  CSV  format  specified   with   -f,   or   $LEDGER_FILE,   or | ||||
|        $HOME/.hledger.journal           (on          windows,          perhaps | ||||
|        C:/Users/USER/.hledger.journal). | ||||
| 
 | ||||
| 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. | ||||
| 
 | ||||
|        -f- doesn't work (hledger-web can't read from stdin). | ||||
| @ -225,7 +226,7 @@ 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) | ||||
| 
 | ||||
| 
 | ||||
| @ -239,7 +240,7 @@ COPYRIGHT | ||||
| 
 | ||||
| 
 | ||||
| SEE ALSO | ||||
|        hledger(1),      hledger-ui(1),     hledger-web(1),     hledger-api(1), | ||||
|        hledger(1),     hledger-ui(1),     hledger-web(1),      hledger-api(1), | ||||
|        hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time- | ||||
|        dot(5), ledger(1) | ||||
| 
 | ||||
|  | ||||
| @ -152,7 +152,7 @@ reportflags = [ | ||||
|  ,flagNone ["cleared","C"]   (setboolopt "cleared") "include only cleared postings/txns" | ||||
|  ,flagNone ["real","R"]      (setboolopt "real") "include only non-virtual postings" | ||||
|  ,flagReq  ["depth"]         (\s opts -> Right $ setopt "depth" s opts) "NUM" "(or -NUM): hide accounts/postings deeper than this" | ||||
|  ,flagNone ["empty","E"]     (setboolopt "empty") "show items with zero amount, normally hidden" | ||||
|  ,flagNone ["empty","E"]     (setboolopt "empty") "show items with zero amount, normally hidden (except in hledger-ui)" | ||||
|  ,flagNone ["cost","B"]      (setboolopt "cost") "convert amounts to their cost at transaction time (using the transaction price, if any)" | ||||
|  ,flagNone ["value","V"]     (setboolopt "value") "convert amounts to their market value on the report end date (using the most recent applicable market price, if any)" | ||||
|  ,flagNone ["auto"]          (setboolopt "auto") "apply automated posting rules to modify transactions" | ||||
|  | ||||
| @ -282,7 +282,7 @@ hide/aggregate accounts or postings more than NUM levels deep | ||||
| .RE | ||||
| .TP | ||||
| .B \f[C]\-E\ \-\-empty\f[] | ||||
| show items with zero amount, normally hidden | ||||
| show items with zero amount, normally hidden (except in hledger\-ui) | ||||
| .RS | ||||
| .RE | ||||
| .TP | ||||
|  | ||||
| @ -225,7 +225,7 @@ by most hledger commands, run 'hledger -h'. | ||||
|      hide/aggregate accounts or postings more than NUM levels deep | ||||
| '-E --empty' | ||||
| 
 | ||||
|      show items with zero amount, normally hidden | ||||
|      show items with zero amount, normally hidden (except in hledger-ui) | ||||
| '-B --cost' | ||||
| 
 | ||||
|      convert amounts to their cost at transaction time (using the | ||||
| @ -2403,131 +2403,131 @@ Node: OPTIONS3634 | ||||
| Ref: #options3736 | ||||
| Node: General options4101 | ||||
| Ref: #general-options4226 | ||||
| Node: Command options6777 | ||||
| Ref: #command-options6928 | ||||
| Node: Command arguments7326 | ||||
| Ref: #command-arguments7480 | ||||
| Node: Argument files7601 | ||||
| Ref: #argument-files7752 | ||||
| Node: Special characters8018 | ||||
| Ref: #special-characters8171 | ||||
| Node: Input files9590 | ||||
| Ref: #input-files9726 | ||||
| Node: Smart dates11696 | ||||
| Ref: #smart-dates11837 | ||||
| Node: Report start & end date12816 | ||||
| Ref: #report-start-end-date12986 | ||||
| Node: Report intervals14051 | ||||
| Ref: #report-intervals14214 | ||||
| Node: Period expressions14615 | ||||
| Ref: #period-expressions14775 | ||||
| Node: Depth limiting18732 | ||||
| Ref: #depth-limiting18876 | ||||
| Node: Pivoting19218 | ||||
| Ref: #pivoting19336 | ||||
| Node: Cost21012 | ||||
| Ref: #cost21120 | ||||
| Node: Market value21238 | ||||
| Ref: #market-value21373 | ||||
| Node: Combining -B and -V22556 | ||||
| Ref: #combining--b-and--v22719 | ||||
| Node: Output destination22866 | ||||
| Ref: #output-destination23028 | ||||
| Node: Output format23311 | ||||
| Ref: #output-format23463 | ||||
| Node: Regular expressions23848 | ||||
| Ref: #regular-expressions23985 | ||||
| Node: QUERIES25346 | ||||
| Ref: #queries25448 | ||||
| Node: COMMANDS29415 | ||||
| Ref: #commands29527 | ||||
| Node: accounts30509 | ||||
| Ref: #accounts30607 | ||||
| Node: activity31853 | ||||
| Ref: #activity31963 | ||||
| Node: add32323 | ||||
| Ref: #add32422 | ||||
| Node: balance35083 | ||||
| Ref: #balance35194 | ||||
| Node: Flat mode38698 | ||||
| Ref: #flat-mode38823 | ||||
| Node: Depth limited balance reports39243 | ||||
| Ref: #depth-limited-balance-reports39444 | ||||
| Node: Multicolumn balance reports39864 | ||||
| Ref: #multicolumn-balance-reports40059 | ||||
| Node: Budgets44748 | ||||
| Ref: #budgets44895 | ||||
| Node: Custom balance output48726 | ||||
| Ref: #custom-balance-output48888 | ||||
| Node: Colour support51054 | ||||
| Ref: #colour-support51186 | ||||
| Node: balancesheet51359 | ||||
| Ref: #balancesheet51495 | ||||
| Node: balancesheetequity53806 | ||||
| Ref: #balancesheetequity53955 | ||||
| Node: cashflow54492 | ||||
| Ref: #cashflow54620 | ||||
| Node: check-dates56743 | ||||
| Ref: #check-dates56870 | ||||
| Node: check-dupes56987 | ||||
| Ref: #check-dupes57111 | ||||
| Node: close57248 | ||||
| Ref: #close57355 | ||||
| Node: help57685 | ||||
| Ref: #help57785 | ||||
| Node: import58859 | ||||
| Ref: #import58973 | ||||
| Node: incomestatement59703 | ||||
| Ref: #incomestatement59837 | ||||
| Node: prices62241 | ||||
| Ref: #prices62356 | ||||
| Node: print62399 | ||||
| Ref: #print62509 | ||||
| Node: print-unique67403 | ||||
| Ref: #print-unique67529 | ||||
| Node: register67597 | ||||
| Ref: #register67724 | ||||
| Node: Custom register output72225 | ||||
| Ref: #custom-register-output72354 | ||||
| Node: register-match73584 | ||||
| Ref: #register-match73718 | ||||
| Node: rewrite73901 | ||||
| Ref: #rewrite74018 | ||||
| Node: stats74087 | ||||
| Ref: #stats74190 | ||||
| Node: tags75060 | ||||
| Ref: #tags75158 | ||||
| Node: test75394 | ||||
| Ref: #test75478 | ||||
| Node: ADD-ON COMMANDS75846 | ||||
| Ref: #add-on-commands75956 | ||||
| Node: Official add-ons77243 | ||||
| Ref: #official-add-ons77383 | ||||
| Node: api77470 | ||||
| Ref: #api77559 | ||||
| Node: ui77611 | ||||
| Ref: #ui77710 | ||||
| Node: web77768 | ||||
| Ref: #web77857 | ||||
| Node: Third party add-ons77903 | ||||
| Ref: #third-party-add-ons78078 | ||||
| Node: diff78213 | ||||
| Ref: #diff78310 | ||||
| Node: iadd78409 | ||||
| Ref: #iadd78523 | ||||
| Node: interest78606 | ||||
| Ref: #interest78727 | ||||
| Node: irr78822 | ||||
| Ref: #irr78920 | ||||
| Node: Experimental add-ons78998 | ||||
| Ref: #experimental-add-ons79150 | ||||
| Node: autosync79441 | ||||
| Ref: #autosync79553 | ||||
| Node: budget79792 | ||||
| Ref: #budget79914 | ||||
| Node: chart79980 | ||||
| Ref: #chart80097 | ||||
| Node: check80168 | ||||
| Ref: #check80270 | ||||
| Node: Command options6800 | ||||
| Ref: #command-options6951 | ||||
| Node: Command arguments7349 | ||||
| Ref: #command-arguments7503 | ||||
| Node: Argument files7624 | ||||
| Ref: #argument-files7775 | ||||
| Node: Special characters8041 | ||||
| Ref: #special-characters8194 | ||||
| Node: Input files9613 | ||||
| Ref: #input-files9749 | ||||
| Node: Smart dates11719 | ||||
| Ref: #smart-dates11860 | ||||
| Node: Report start & end date12839 | ||||
| Ref: #report-start-end-date13009 | ||||
| Node: Report intervals14074 | ||||
| Ref: #report-intervals14237 | ||||
| Node: Period expressions14638 | ||||
| Ref: #period-expressions14798 | ||||
| Node: Depth limiting18755 | ||||
| Ref: #depth-limiting18899 | ||||
| Node: Pivoting19241 | ||||
| Ref: #pivoting19359 | ||||
| Node: Cost21035 | ||||
| Ref: #cost21143 | ||||
| Node: Market value21261 | ||||
| Ref: #market-value21396 | ||||
| Node: Combining -B and -V22579 | ||||
| Ref: #combining--b-and--v22742 | ||||
| Node: Output destination22889 | ||||
| Ref: #output-destination23051 | ||||
| Node: Output format23334 | ||||
| Ref: #output-format23486 | ||||
| Node: Regular expressions23871 | ||||
| Ref: #regular-expressions24008 | ||||
| Node: QUERIES25369 | ||||
| Ref: #queries25471 | ||||
| Node: COMMANDS29438 | ||||
| Ref: #commands29550 | ||||
| Node: accounts30532 | ||||
| Ref: #accounts30630 | ||||
| Node: activity31876 | ||||
| Ref: #activity31986 | ||||
| Node: add32346 | ||||
| Ref: #add32445 | ||||
| Node: balance35106 | ||||
| Ref: #balance35217 | ||||
| Node: Flat mode38721 | ||||
| Ref: #flat-mode38846 | ||||
| Node: Depth limited balance reports39266 | ||||
| Ref: #depth-limited-balance-reports39467 | ||||
| Node: Multicolumn balance reports39887 | ||||
| Ref: #multicolumn-balance-reports40082 | ||||
| Node: Budgets44771 | ||||
| Ref: #budgets44918 | ||||
| Node: Custom balance output48749 | ||||
| Ref: #custom-balance-output48911 | ||||
| Node: Colour support51077 | ||||
| Ref: #colour-support51209 | ||||
| Node: balancesheet51382 | ||||
| Ref: #balancesheet51518 | ||||
| Node: balancesheetequity53829 | ||||
| Ref: #balancesheetequity53978 | ||||
| Node: cashflow54515 | ||||
| Ref: #cashflow54643 | ||||
| Node: check-dates56766 | ||||
| Ref: #check-dates56893 | ||||
| Node: check-dupes57010 | ||||
| Ref: #check-dupes57134 | ||||
| Node: close57271 | ||||
| Ref: #close57378 | ||||
| Node: help57708 | ||||
| Ref: #help57808 | ||||
| Node: import58882 | ||||
| Ref: #import58996 | ||||
| Node: incomestatement59726 | ||||
| Ref: #incomestatement59860 | ||||
| Node: prices62264 | ||||
| Ref: #prices62379 | ||||
| Node: print62422 | ||||
| Ref: #print62532 | ||||
| Node: print-unique67426 | ||||
| Ref: #print-unique67552 | ||||
| Node: register67620 | ||||
| Ref: #register67747 | ||||
| Node: Custom register output72248 | ||||
| Ref: #custom-register-output72377 | ||||
| Node: register-match73607 | ||||
| Ref: #register-match73741 | ||||
| Node: rewrite73924 | ||||
| Ref: #rewrite74041 | ||||
| Node: stats74110 | ||||
| Ref: #stats74213 | ||||
| Node: tags75083 | ||||
| Ref: #tags75181 | ||||
| Node: test75417 | ||||
| Ref: #test75501 | ||||
| Node: ADD-ON COMMANDS75869 | ||||
| Ref: #add-on-commands75979 | ||||
| Node: Official add-ons77266 | ||||
| Ref: #official-add-ons77406 | ||||
| Node: api77493 | ||||
| Ref: #api77582 | ||||
| Node: ui77634 | ||||
| Ref: #ui77733 | ||||
| Node: web77791 | ||||
| Ref: #web77880 | ||||
| Node: Third party add-ons77926 | ||||
| Ref: #third-party-add-ons78101 | ||||
| Node: diff78236 | ||||
| Ref: #diff78333 | ||||
| Node: iadd78432 | ||||
| Ref: #iadd78546 | ||||
| Node: interest78629 | ||||
| Ref: #interest78750 | ||||
| Node: irr78845 | ||||
| Ref: #irr78943 | ||||
| Node: Experimental add-ons79021 | ||||
| Ref: #experimental-add-ons79173 | ||||
| Node: autosync79464 | ||||
| Ref: #autosync79576 | ||||
| Node: budget79815 | ||||
| Ref: #budget79937 | ||||
| Node: chart80003 | ||||
| Ref: #chart80120 | ||||
| Node: check80191 | ||||
| Ref: #check80293 | ||||
|  | ||||
| End Tag Table | ||||
|  | ||||
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
		Loading…
	
		Reference in New Issue
	
	Block a user