update embedded manuals
This commit is contained in:
		
							parent
							
								
									3e866563d1
								
							
						
					
					
						commit
						6632aedd93
					
				| @ -161,6 +161,7 @@ m4_define({{_optionnotes_}}, {{ | |||||||
| 
 | 
 | ||||||
| A @FILE argument will be expanded to the contents of FILE, | A @FILE argument will be expanded to the contents of FILE, | ||||||
| which should contain one command line option/argument per line. | which should contain one command line option/argument per line. | ||||||
|  | (To prevent this, insert a `--` argument before.) | ||||||
| 
 | 
 | ||||||
| When multiple similar reporting options are provided, the last one takes precedence. | When multiple similar reporting options are provided, the last one takes precedence. | ||||||
| Eg `--depth 3 --depth 1` is equivalent to `--depth 1`. | Eg `--depth 3 --depth 1` is equivalent to `--depth 1`. | ||||||
|  | |||||||
| @ -204,6 +204,17 @@ show version | |||||||
| show debug output (levels 1\-9, default: 1) | show debug output (levels 1\-9, default: 1) | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
|  | .PP | ||||||
|  | A \@FILE argument will be expanded to the contents of FILE, which should | ||||||
|  | contain one command line option/argument per line. | ||||||
|  | (To prevent this, insert a \f[C]\-\-\f[] argument before.) | ||||||
|  | .PP | ||||||
|  | When multiple similar reporting options are provided, the last one takes | ||||||
|  | precedence. | ||||||
|  | Eg \f[C]\-\-depth\ 3\ \-\-depth\ 1\f[] is equivalent to | ||||||
|  | \f[C]\-\-depth\ 1\f[]. | ||||||
|  | .PP | ||||||
|  | Some of the reporting options can also be written as query arguments. | ||||||
| .SH KEYS | .SH KEYS | ||||||
| .PP | .PP | ||||||
| \f[C]?\f[] shows a help dialog listing all keys. | \f[C]?\f[] shows a help dialog listing all keys. | ||||||
|  | |||||||
| @ -144,6 +144,16 @@ the data. | |||||||
| 
 | 
 | ||||||
|      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 contain one command line option/argument per line.  (To prevent | ||||||
|  | this, insert a '--' argument before.) | ||||||
|  | 
 | ||||||
|  |    When multiple similar reporting options are provided, the last one | ||||||
|  | takes precedence.  Eg '--depth 3 --depth 1' is equivalent to '--depth | ||||||
|  | 1'. | ||||||
|  | 
 | ||||||
|  |    Some of the reporting options can also be written as query arguments. | ||||||
|  | 
 | ||||||
|  |  | ||||||
| File: hledger-ui.1.info,  Node: KEYS,  Next: SCREENS,  Prev: OPTIONS,  Up: Top | File: hledger-ui.1.info,  Node: KEYS,  Next: SCREENS,  Prev: OPTIONS,  Up: Top | ||||||
| 
 | 
 | ||||||
| @ -358,17 +368,17 @@ Tag Table: | |||||||
| Node: Top73 | Node: Top73 | ||||||
| Node: OPTIONS831 | Node: OPTIONS831 | ||||||
| Ref: #options930 | Ref: #options930 | ||||||
| Node: KEYS3519 | Node: KEYS3916 | ||||||
| Ref: #keys3616 | Ref: #keys4013 | ||||||
| Node: SCREENS6412 | Node: SCREENS6809 | ||||||
| Ref: #screens6499 | Ref: #screens6896 | ||||||
| Node: Accounts screen6589 | Node: Accounts screen6986 | ||||||
| Ref: #accounts-screen6719 | Ref: #accounts-screen7116 | ||||||
| Node: Register screen8949 | Node: Register screen9346 | ||||||
| Ref: #register-screen9106 | Ref: #register-screen9503 | ||||||
| Node: Transaction screen11180 | Node: Transaction screen11577 | ||||||
| Ref: #transaction-screen11340 | Ref: #transaction-screen11737 | ||||||
| Node: Error screen12210 | Node: Error screen12607 | ||||||
| Ref: #error-screen12334 | Ref: #error-screen12731 | ||||||
|  |  | ||||||
| End Tag Table | End Tag Table | ||||||
|  | |||||||
| @ -139,57 +139,66 @@ OPTIONS | |||||||
|        --debug[=N] |        --debug[=N] | ||||||
|               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 | ||||||
|  |        contain one command line option/argument per line.  (To  prevent  this, | ||||||
|  |        insert a -- argument before.) | ||||||
|  | 
 | ||||||
|  |        When  multiple  similar  reporting  options  are provided, the last one | ||||||
|  |        takes precedence.  Eg --depth 3 --depth 1 is equivalent to --depth 1. | ||||||
|  | 
 | ||||||
|  |        Some of the reporting options can also be written as query arguments. | ||||||
|  | 
 | ||||||
| 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) to close it.  The following keys work on most screens: |        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 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.     Vi-style    (h/j/k/l)   and   Emacs-style |        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: |        (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 |        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 |        you  may  want to adjust it.  (If you're on a mac, the Karabiner app is | ||||||
|        one way to do that.) |        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). |        the   transactions   to   be   shown   (by  default,  all  are  shown). | ||||||
|        shift-down/up  steps  downward and upward through these standard report |        shift-down/up steps downward and upward through these  standard  report | ||||||
|        period   durations:   year,   quarter,   month,   week,   day.    Then, |        period   durations:   year,   quarter,   month,   week,   day.    Then, | ||||||
|        shift-left/right  moves to the previous/next period.  t sets the report |        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  to  today.   With  the --watch option, when viewing a "current" | ||||||
|        period  (the  current  day,  week, month, quarter, or year), the period |        period (the current day, week, month, quarter,  or  year),  the  period | ||||||
|        will move automatically to track the current date.  To set a  non-stan- |        will  move automatically to track the current date.  To set a non-stan- | ||||||
|        dard period, you can use / and a date: query. |        dard period, you can use / 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. | ||||||
| 
 | 
 | ||||||
|        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. |        cancels a minibuffer edit or help dialog in progress. | ||||||
| 
 | 
 | ||||||
|        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. | ||||||
| 
 | 
 | ||||||
|        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), |        sclient -a "" -nw) on the journal file.  With some editors (emacs, vi), | ||||||
|        the  cursor  will be positioned at the current transaction when invoked |        the cursor will be positioned at the current transaction  when  invoked | ||||||
|        from the register and transaction screens, and at  the  error  location |        from  the  register  and transaction screens, and at the error location | ||||||
|        (if possible) when invoked from the error screen. |        (if possible) when invoked from the error screen. | ||||||
| 
 | 
 | ||||||
|        q quits the application. |        q quits the application. | ||||||
| @ -198,44 +207,44 @@ 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 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. |        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.  - |        0 shows even less detail, collapsing all accounts to a single total.  - | ||||||
|        and + (or =) decrease and increase the  depth  limit.   To  remove  the |        and  +  (or  =)  decrease  and increase the depth limit.  To remove the | ||||||
|        depth  limit,  set  it  higher than the maximum account depth, or press |        depth limit, set it higher than the maximum  account  depth,  or  press | ||||||
|        ESCAPE. |        ESCAPE. | ||||||
| 
 | 
 | ||||||
|        F toggles flat mode, in which accounts are shown as a flat  list,  with |        F  toggles  flat mode, in which accounts are shown as a flat list, with | ||||||
|        their  full names.  In this mode, account balances exclude subaccounts, |        their full names.  In this mode, account balances exclude  subaccounts, | ||||||
|        except for accounts at the depth limit (as with hledger's balance  com- |        except  for accounts at the depth limit (as with hledger's balance com- | ||||||
|        mand). |        mand). | ||||||
| 
 | 
 | ||||||
|        H toggles between showing historical balances or period balances.  His- |        H toggles between showing historical balances or period balances.  His- | ||||||
|        torical balances (the default) are ending balances at the  end  of  the |        torical  balances  (the  default) are ending balances at the end of the | ||||||
|        report  period,  taking  into account all transactions before that date |        report period, taking into account all transactions  before  that  date | ||||||
|        (filtered by the filter query if any),  including  transactions  before |        (filtered  by  the  filter query if any), including transactions before | ||||||
|        the  start  of  the report period.  In other words, historical balances |        the start of the report period.  In other  words,  historical  balances | ||||||
|        are what you would see on a bank statement  for  that  account  (unless |        are  what  you  would  see on a bank statement for that account (unless | ||||||
|        disturbed  by  a  filter  query).   Period balances ignore transactions |        disturbed by a filter  query).   Period  balances  ignore  transactions | ||||||
|        before the report start date, so they show the change in balance during |        before the report start date, so they show the change in balance during | ||||||
|        the report period.  They are more useful eg when viewing a time log. |        the report period.  They are more useful eg when viewing a time log. | ||||||
| 
 | 
 | ||||||
|        U toggles filtering by unmarked status, including or excluding unmarked |        U toggles filtering by unmarked status, including or excluding unmarked | ||||||
|        postings in the balances.  Similarly, P toggles pending postings, and C |        postings in the balances.  Similarly, P toggles pending postings, and C | ||||||
|        toggles  cleared postings.  (By default, balances include all postings; |        toggles cleared postings.  (By default, balances include all  postings; | ||||||
|        if you activate one or two status  filters,  only  those  postings  are |        if  you  activate  one  or  two status filters, only those postings are | ||||||
|        included; and if you activate all three, the filter is removed.) |        included; and if you activate all three, the filter is removed.) | ||||||
| 
 | 
 | ||||||
|        R toggles real mode, in which virtual postings are ignored. |        R toggles real mode, in which virtual postings are ignored. | ||||||
| 
 | 
 | ||||||
|        Z  toggles  nonzero  mode, in which only accounts with nonzero balances |        Z toggles nonzero mode, in which only accounts  with  nonzero  balances | ||||||
|        are shown (hledger-ui shows zero items by default, unlike  command-line |        are  shown (hledger-ui shows zero items by default, unlike command-line | ||||||
|        hledger). |        hledger). | ||||||
| 
 | 
 | ||||||
|        Press right or enter to view an account's transactions register. |        Press right or enter to view an account's transactions register. | ||||||
| @ -244,65 +253,65 @@ 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. | ||||||
| 
 | 
 | ||||||
|        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. |        include transactions from both the current account and its subaccounts. | ||||||
|        If  the  accounts  screen  was  in  flat  mode, and a non-depth-clipped |        If the accounts screen  was  in  flat  mode,  and  a  non-depth-clipped | ||||||
|        account was selected, the register  screen  will  exclude  transactions |        account  was  selected,  the  register screen will exclude transactions | ||||||
|        from subaccounts.  In other words, the register always shows the trans- |        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. |        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 |        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 |        tions are  shown;  and  if  you  activate  all  three,  the  filter  is | ||||||
|        removed.)q |        removed.)q | ||||||
| 
 | 
 | ||||||
|        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, |        The  transaction's  date(s)  and  any  cleared  flag, transaction code, | ||||||
|        description,  comments,  along  with  all  of  its account postings are |        description, comments, along with  all  of  its  account  postings  are | ||||||
|        shown.  Simple transactions have two postings, but there  can  be  more |        shown.   Simple  transactions  have two postings, but there can be more | ||||||
|        (or in certain cases, fewer). |        (or in 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 |        show your position  within  that  account  register.   They  will  vary | ||||||
|        depending on which account register you came from (remember most trans- |        depending on which account register you came from (remember most trans- | ||||||
|        actions appear in multiple account registers).  The #N number preceding |        actions 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.) | ||||||
| 
 | 
 | ||||||
| @ -310,17 +319,17 @@ 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). | ||||||
| 
 | 
 | ||||||
| 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). | ||||||
| @ -328,13 +337,13 @@ 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. | ||||||
| @ -342,7 +351,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) | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| @ -356,7 +365,7 @@ COPYRIGHT | |||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| SEE ALSO | 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- |        hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time- | ||||||
|        dot(5), ledger(1) |        dot(5), ledger(1) | ||||||
| 
 | 
 | ||||||
|  | |||||||
| @ -260,6 +260,17 @@ show version | |||||||
| show debug output (levels 1\-9, default: 1) | show debug output (levels 1\-9, default: 1) | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
|  | .PP | ||||||
|  | A \@FILE argument will be expanded to the contents of FILE, which should | ||||||
|  | contain one command line option/argument per line. | ||||||
|  | (To prevent this, insert a \f[C]\-\-\f[] argument before.) | ||||||
|  | .PP | ||||||
|  | When multiple similar reporting options are provided, the last one takes | ||||||
|  | precedence. | ||||||
|  | Eg \f[C]\-\-depth\ 3\ \-\-depth\ 1\f[] is equivalent to | ||||||
|  | \f[C]\-\-depth\ 1\f[]. | ||||||
|  | .PP | ||||||
|  | Some of the reporting options can also be written as query arguments. | ||||||
| .SH ENVIRONMENT | .SH ENVIRONMENT | ||||||
| .PP | .PP | ||||||
| \f[B]LEDGER_FILE\f[] The journal file path when not specified with | \f[B]LEDGER_FILE\f[] The journal file path when not specified with | ||||||
|  | |||||||
| @ -189,6 +189,16 @@ options as shown above. | |||||||
| 
 | 
 | ||||||
|      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 contain one command line option/argument per line.  (To prevent | ||||||
|  | this, insert a '--' argument before.) | ||||||
|  | 
 | ||||||
|  |    When multiple similar reporting options are provided, the last one | ||||||
|  | takes precedence.  Eg '--depth 3 --depth 1' is equivalent to '--depth | ||||||
|  | 1'. | ||||||
|  | 
 | ||||||
|  |    Some of the reporting options can also be written as query arguments. | ||||||
|  | 
 | ||||||
|  |  | ||||||
| Tag Table: | Tag Table: | ||||||
| Node: Top74 | Node: Top74 | ||||||
|  | |||||||
| @ -184,19 +184,28 @@ OPTIONS | |||||||
|        --debug[=N] |        --debug[=N] | ||||||
|               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 | ||||||
|  |        contain  one  command line option/argument per line.  (To prevent this, | ||||||
|  |        insert a -- argument before.) | ||||||
|  | 
 | ||||||
|  |        When multiple similar reporting options  are  provided,  the  last  one | ||||||
|  |        takes precedence.  Eg --depth 3 --depth 1 is equivalent to --depth 1. | ||||||
|  | 
 | ||||||
|  |        Some of the reporting options can also be written as query arguments. | ||||||
|  | 
 | ||||||
| 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). | ||||||
| 
 | 
 | ||||||
| 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). | ||||||
| @ -210,7 +219,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) | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| @ -224,7 +233,7 @@ COPYRIGHT | |||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| SEE ALSO | 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- |        hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time- | ||||||
|        dot(5), ledger(1) |        dot(5), ledger(1) | ||||||
| 
 | 
 | ||||||
|  | |||||||
| @ -301,6 +301,7 @@ most recent applicable market price, if any) | |||||||
| .PP | .PP | ||||||
| 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. | contain one command line option/argument per line. | ||||||
|  | (To prevent this, insert a \f[C]\-\-\f[] argument before.) | ||||||
| .PP | .PP | ||||||
| When multiple similar reporting options are provided, the last one takes | When multiple similar reporting options are provided, the last one takes | ||||||
| precedence. | precedence. | ||||||
|  | |||||||
| @ -233,7 +233,8 @@ different, like git.) | |||||||
|      the most recent applicable market price, if any) |      the most recent applicable market price, if any) | ||||||
| 
 | 
 | ||||||
|    A @FILE argument will be expanded to the contents of FILE, which |    A @FILE argument will be expanded to the contents of FILE, which | ||||||
| should contain one command line option/argument per line. | should contain one command line option/argument per line.  (To prevent | ||||||
|  | this, insert a '--' argument before.) | ||||||
| 
 | 
 | ||||||
|    When multiple similar reporting options are provided, the last one |    When multiple similar reporting options are provided, the last one | ||||||
| takes precedence.  Eg '--depth 3 --depth 1' is equivalent to '--depth | takes precedence.  Eg '--depth 3 --depth 1' is equivalent to '--depth | ||||||
| @ -2203,125 +2204,125 @@ Node: OPTIONS3640 | |||||||
| Ref: #options3744 | Ref: #options3744 | ||||||
| Node: General options4025 | Node: General options4025 | ||||||
| Ref: #general-options4152 | Ref: #general-options4152 | ||||||
| Node: Command options6693 | Node: Command options6744 | ||||||
| Ref: #command-options6846 | Ref: #command-options6897 | ||||||
| Node: Command arguments7244 | Node: Command arguments7295 | ||||||
| Ref: #command-arguments7404 | Ref: #command-arguments7455 | ||||||
| Node: Special characters7525 | Node: Special characters7576 | ||||||
| Ref: #special-characters7683 | Ref: #special-characters7734 | ||||||
| Node: Input files8851 | Node: Input files8902 | ||||||
| Ref: #input-files8989 | Ref: #input-files9040 | ||||||
| Node: Smart dates10952 | Node: Smart dates11003 | ||||||
| Ref: #smart-dates11095 | Ref: #smart-dates11146 | ||||||
| Node: Report start & end date12074 | Node: Report start & end date12125 | ||||||
| Ref: #report-start-end-date12246 | Ref: #report-start-end-date12297 | ||||||
| Node: Report intervals13312 | Node: Report intervals13363 | ||||||
| Ref: #report-intervals13477 | Ref: #report-intervals13528 | ||||||
| Node: Period expressions13878 | Node: Period expressions13929 | ||||||
| Ref: #period-expressions14038 | Ref: #period-expressions14089 | ||||||
| Node: Depth limiting16378 | Node: Depth limiting16429 | ||||||
| Ref: #depth-limiting16524 | Ref: #depth-limiting16575 | ||||||
| Node: Pivoting16866 | Node: Pivoting16917 | ||||||
| Ref: #pivoting16986 | Ref: #pivoting17037 | ||||||
| Node: Cost18662 | Node: Cost18713 | ||||||
| Ref: #cost18772 | Ref: #cost18823 | ||||||
| Node: Market value18890 | Node: Market value18941 | ||||||
| Ref: #market-value19027 | Ref: #market-value19078 | ||||||
| Node: Regular expressions20327 | Node: Regular expressions20378 | ||||||
| Ref: #regular-expressions20465 | Ref: #regular-expressions20516 | ||||||
| Node: QUERIES21826 | Node: QUERIES21877 | ||||||
| Ref: #queries21930 | Ref: #queries21981 | ||||||
| Node: COMMANDS25897 | Node: COMMANDS25948 | ||||||
| Ref: #commands26011 | Ref: #commands26062 | ||||||
| Node: accounts26994 | Node: accounts27045 | ||||||
| Ref: #accounts27094 | Ref: #accounts27145 | ||||||
| Node: activity28087 | Node: activity28138 | ||||||
| Ref: #activity28199 | Ref: #activity28250 | ||||||
| Node: add28558 | Node: add28609 | ||||||
| Ref: #add28659 | Ref: #add28710 | ||||||
| Node: balance31317 | Node: balance31368 | ||||||
| Ref: #balance31430 | Ref: #balance31481 | ||||||
| Node: Flat mode34587 | Node: Flat mode34638 | ||||||
| Ref: #flat-mode34714 | Ref: #flat-mode34765 | ||||||
| Node: Depth limited balance reports35134 | Node: Depth limited balance reports35185 | ||||||
| Ref: #depth-limited-balance-reports35337 | Ref: #depth-limited-balance-reports35388 | ||||||
| Node: Multicolumn balance reports35757 | Node: Multicolumn balance reports35808 | ||||||
| Ref: #multicolumn-balance-reports35968 | Ref: #multicolumn-balance-reports36019 | ||||||
| Node: Custom balance output40616 | Node: Custom balance output40667 | ||||||
| Ref: #custom-balance-output40800 | Ref: #custom-balance-output40851 | ||||||
| Node: Colour support42893 | Node: Colour support42944 | ||||||
| Ref: #colour-support43054 | Ref: #colour-support43105 | ||||||
| Node: Output destination43227 | Node: Output destination43278 | ||||||
| Ref: #output-destination43385 | Ref: #output-destination43436 | ||||||
| Node: CSV output43655 | Node: CSV output43706 | ||||||
| Ref: #csv-output43774 | Ref: #csv-output43825 | ||||||
| Node: balancesheet44171 | Node: balancesheet44222 | ||||||
| Ref: #balancesheet44309 | Ref: #balancesheet44360 | ||||||
| Node: balancesheetequity46277 | Node: balancesheetequity46328 | ||||||
| Ref: #balancesheetequity46428 | Ref: #balancesheetequity46479 | ||||||
| Node: cashflow47217 | Node: cashflow47268 | ||||||
| Ref: #cashflow47347 | Ref: #cashflow47398 | ||||||
| Node: check-dates49259 | Node: check-dates49310 | ||||||
| Ref: #check-dates49388 | Ref: #check-dates49439 | ||||||
| Node: check-dupes49505 | Node: check-dupes49556 | ||||||
| Ref: #check-dupes49632 | Ref: #check-dupes49683 | ||||||
| Node: equity49769 | Node: equity49820 | ||||||
| Ref: #equity49881 | Ref: #equity49932 | ||||||
| Node: help50044 | Node: help50095 | ||||||
| Ref: #help50147 | Ref: #help50198 | ||||||
| Node: import51221 | Node: import51272 | ||||||
| Ref: #import51337 | Ref: #import51388 | ||||||
| Node: incomestatement51732 | Node: incomestatement51783 | ||||||
| Ref: #incomestatement51868 | Ref: #incomestatement51919 | ||||||
| Node: prices53821 | Node: prices53872 | ||||||
| Ref: #prices53938 | Ref: #prices53989 | ||||||
| Node: print53981 | Node: print54032 | ||||||
| Ref: #print54093 | Ref: #print54144 | ||||||
| Node: print-unique58939 | Node: print-unique58990 | ||||||
| Ref: #print-unique59067 | Ref: #print-unique59118 | ||||||
| Node: register59135 | Node: register59186 | ||||||
| Ref: #register59264 | Ref: #register59315 | ||||||
| Node: Custom register output63765 | Node: Custom register output63816 | ||||||
| Ref: #custom-register-output63896 | Ref: #custom-register-output63947 | ||||||
| Node: register-match65193 | Node: register-match65244 | ||||||
| Ref: #register-match65329 | Ref: #register-match65380 | ||||||
| Node: rewrite65512 | Node: rewrite65563 | ||||||
| Ref: #rewrite65631 | Ref: #rewrite65682 | ||||||
| Node: stats65700 | Node: stats65751 | ||||||
| Ref: #stats65805 | Ref: #stats65856 | ||||||
| Node: tags66686 | Node: tags66737 | ||||||
| Ref: #tags66786 | Ref: #tags66837 | ||||||
| Node: test66818 | Node: test66869 | ||||||
| Ref: #test66904 | Ref: #test66955 | ||||||
| Node: ADD-ON COMMANDS67272 | Node: ADD-ON COMMANDS67323 | ||||||
| Ref: #add-on-commands67384 | Ref: #add-on-commands67435 | ||||||
| Node: Official add-ons68671 | Node: Official add-ons68722 | ||||||
| Ref: #official-add-ons68813 | Ref: #official-add-ons68864 | ||||||
| Node: api68900 | Node: api68951 | ||||||
| Ref: #api68991 | Ref: #api69042 | ||||||
| Node: ui69043 | Node: ui69094 | ||||||
| Ref: #ui69144 | Ref: #ui69195 | ||||||
| Node: web69202 | Node: web69253 | ||||||
| Ref: #web69293 | Ref: #web69344 | ||||||
| Node: Third party add-ons69339 | Node: Third party add-ons69390 | ||||||
| Ref: #third-party-add-ons69516 | Ref: #third-party-add-ons69567 | ||||||
| Node: diff69651 | Node: diff69702 | ||||||
| Ref: #diff69750 | Ref: #diff69801 | ||||||
| Node: iadd69849 | Node: iadd69900 | ||||||
| Ref: #iadd69965 | Ref: #iadd70016 | ||||||
| Node: interest70048 | Node: interest70099 | ||||||
| Ref: #interest70171 | Ref: #interest70222 | ||||||
| Node: irr70266 | Node: irr70317 | ||||||
| Ref: #irr70366 | Ref: #irr70417 | ||||||
| Node: Experimental add-ons70444 | Node: Experimental add-ons70495 | ||||||
| Ref: #experimental-add-ons70598 | Ref: #experimental-add-ons70649 | ||||||
| Node: autosync70889 | Node: autosync70940 | ||||||
| Ref: #autosync71003 | Ref: #autosync71054 | ||||||
| Node: budget71242 | Node: budget71293 | ||||||
| Ref: #budget71366 | Ref: #budget71417 | ||||||
| Node: chart71432 | Node: chart71483 | ||||||
| Ref: #chart71551 | Ref: #chart71602 | ||||||
| Node: check71622 | Node: check71673 | ||||||
| Ref: #check71726 | Ref: #check71777 | ||||||
|  |  | ||||||
| End Tag Table | End Tag Table | ||||||
|  | |||||||
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
		Loading…
	
		Reference in New Issue
	
	Block a user