/usr/share/doc/ledger/ledger.html/Output-customization.html is in ledger 2.6.2-3.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 | <html lang="en">
<head>
<title>Output customization - Ledger: Command-Line Accounting</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="description" content="Ledger: Command-Line Accounting">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Options.html#Options" title="Options">
<link rel="prev" href="Report-filtering.html#Report-filtering" title="Report filtering">
<link rel="next" href="Commodity-reporting.html#Commodity-reporting" title="Commodity reporting">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (c) 2003-2009, John Wiegley. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
- Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
- Neither the name of New Artisans LLC nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Output-customization"></a>
<p>
Next: <a rel="next" accesskey="n" href="Commodity-reporting.html#Commodity-reporting">Commodity reporting</a>,
Previous: <a rel="previous" accesskey="p" href="Report-filtering.html#Report-filtering">Report filtering</a>,
Up: <a rel="up" accesskey="u" href="Options.html#Options">Options</a>
<hr>
</div>
<h4 class="subsection">2.3.3 Output customization</h4>
<p>These options affect only the output, but not which transactions are
used to create it:
<p><samp><span class="option">--collapse</span></samp> (<samp><span class="option">-n</span></samp>) causes entries in a
<samp><span class="command">register</span></samp> report with multiple transactions to be collapsed
into a single, subtotaled entry.
<p><samp><span class="option">--subtotal</span></samp> (<samp><span class="option">-s</span></samp>) causes all entries in a
<samp><span class="command">register</span></samp> report to be collapsed into a single, subtotaled
entry.
<p><samp><span class="option">--by-payee</span></samp> (<samp><span class="option">-P</span></samp>) reports subtotals by payee.
<p><samp><span class="option">--comm-as-payee</span></samp> (<samp><span class="option">-x</span></samp>) changes the payee of every
transaction to be the commodity used in that transaction. This can be
useful when combined with other options, such as <samp><span class="option">-s</span></samp>.
<p><samp><span class="option">--empty</span></samp> (<samp><span class="option">-E</span></samp>) includes even empty accounts in the
<samp><span class="command">balance</span></samp> report.
<p><samp><span class="option">--weekly</span></samp> (<samp><span class="option">-W</span></samp>) reports transaction totals by the
week. The week begins on whichever day of the week begins the month
containing that transaction. To set a specific begin date, use a
period string, such as ‘<samp><span class="samp">weekly from DATE</span></samp>’. <samp><span class="option">--monthly</span></samp>
(<samp><span class="option">-M</span></samp>) reports transaction totals by month; <samp><span class="option">--yearly</span></samp>
(<samp><span class="option">-Y</span></samp>) reports transaction totals by year. For more complex
period, using the <samp><span class="option">--period</span></samp> option described above.
<p><samp><span class="option">--dow</span></samp> reports transactions totals for each day of the week.
This is an easy way to see if weekend spending is more than on
weekdays.
<p><samp><span class="option">--sort EXPR</span></samp> (<samp><span class="option">-S EXPR</span></samp>) sorts a report by comparing
the values determined using the value expression <var>EXPR</var>. For
example, using <samp><span class="option">-S -UT</span></samp> in the balance report will sort account
balances from greatest to least, using the absolute value of the
total. For more on how to use value expressions, see <a href="Value-expressions.html#Value-expressions">Value expressions</a>.
<p><samp><span class="option">--wide</span></samp> (<samp><span class="option">-w</span></samp>) causes the default <samp><span class="command">register</span></samp>
report to assume 132 columns instead of 80.
<p><samp><span class="option">--head</span></samp> causes only the first N entries to be printed. This
is different from using the command-line utility <samp><span class="command">head</span></samp>, which
would limit to the first N transactions. <samp><span class="option">--tail</span></samp> outputs only
the last N entries. Both options may be used simultaneously. If a
negative amount is given, it will invert the meaning of the flag
(instead of the first five entries being printed, for example, it
would print all but the first five).
<p><samp><span class="option">--pager</span></samp> tells Ledger to pass its output to the given pager
program—very useful when the output is especially long. This
behavior can be made the default by setting the <samp><span class="env">LEDGER_PAGER</span></samp>
environment variable.
<p><samp><span class="option">--average</span></samp> (<samp><span class="option">-A</span></samp>) reports the average transaction
value.
<p><samp><span class="option">--deviation</span></samp> (<samp><span class="option">-D</span></samp>) reports each transaction's
deviation from the average. It is only meaningful in the
<samp><span class="command">register</span></samp> and <samp><span class="command">prices</span></samp> reports.
<p><samp><span class="option">--percentage</span></samp> (<samp><span class="option">-%</span></samp>) shows account subtotals in the
<samp><span class="command">balance</span></samp> report as percentages of the parent account.
<p><samp><span class="option">--totals</span></samp> include running total information in the
<samp><span class="command">xml</span></samp> report.
<p><samp><span class="option">--amount-data</span></samp> (<samp><span class="option">-j</span></samp>) changes the <samp><span class="command">register</span></samp>
report so that it output nothing but the date and the value column,
and the latter without commodities. This is only meaningful if the
report uses a single commodity. This data can then be fed to other
programs, which could plot the date, analyze it, etc.
<p><samp><span class="option">--total-data</span></samp> (<samp><span class="option">-J</span></samp>) changes the <samp><span class="command">register</span></samp>
report so that it output nothing but the date and totals column,
without commodities.
<p><samp><span class="option">--display EXPR</span></samp> (<samp><span class="option">-d EXPR</span></samp>) limits which transactions
or accounts or actually displayed in a report. They might still be
calculated, and be part of the running total of a register report, for
example, but they will not be displayed. This is useful for seeing
last month's checking transactions, against a running balance which
includes all transaction values:
<pre class="example"> ledger -d "d>=[last month]" reg checking
</pre>
<p>The output from this command is very different from the following,
whose running total includes only transactions from the last month
onward:
<pre class="example"> ledger -p "last month" reg checking
</pre>
<p>Which is more useful depends on what you're looking to know: the total
amount for the reporting range (<samp><span class="option">-p</span></samp>), or simply a display
restricted to the reporting range (using <samp><span class="option">-d</span></samp>).
<p><samp><span class="option">--date-format STR</span></samp> (<samp><span class="option">-y STR</span></samp>) changes the basic date
format used by reports. The default uses a date like 2004/08/01,
which represents the default date format of ‘<samp><span class="samp">%Y/%m/%d</span></samp>’. To
change the way dates are printed in general, the easiest way is to put
<samp><span class="option">--date-format FORMAT</span></samp> in the Ledger initialization file
<samp><span class="file">~/.ledgerrc</span></samp> (or the file referred to by <samp><span class="env">LEDGER_INIT</span></samp>).
<p><samp><span class="option">--format STR</span></samp> (<samp><span class="option">-F STR</span></samp>) sets the reporting format for
whatever report ledger is about to make. See <a href="Format-strings.html#Format-strings">Format strings</a>.
There are also specific format commands for each report type:
<ul>
<li><samp><span class="option">--balance-format STR</span></samp>
<li><samp><span class="option">--register-format STR</span></samp>
<li><samp><span class="option">--print-format STR</span></samp>
<li><samp><span class="option">--plot-amount-format STR</span></samp> (-j <samp><span class="command">register</span></samp>)
<li><samp><span class="option">--plot-total-format STR</span></samp> (-J <samp><span class="command">register</span></samp>)
<li><samp><span class="option">--equity-format STR</span></samp>
<li><samp><span class="option">--prices-format STR</span></samp>
<li><samp><span class="option">--wide-register-format STR</span></samp> (-w <samp><span class="command">register</span></samp>)
</ul>
</body></html>
|