From 37a72568b71747e8bfa40b85c6ed769c247a71b5 Mon Sep 17 00:00:00 2001
From: Simon Michael <simon@joyful.com>
Date: Tue, 16 Feb 2010 20:43:15 +0000
Subject: [PATCH] docs: describe --depth, especially its behaviour with
 register

---
 MANUAL | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/MANUAL b/MANUAL
index 150ccedeb..9904fb37d 100644
--- a/MANUAL
+++ b/MANUAL
@@ -635,6 +635,23 @@ Note the use of >= here to include the first of the month::
 
  $ hledger register -d "d>=[this month]"
 
+Depth limiting
+""""""""""""""
+
+With the ``--depth N`` option, reports will show only the uppermost
+accounts in the account tree, down to level N. This is most useful with
+`balance <#balance>`_ (and `chart <#chart>`_). For example::
+
+ $ hledger balance --depth 2
+
+shows a more concise balance report displaying only the top two levels of
+accounts.  This example with `register <#register>`_::
+
+ $ hledger register --depth 1
+
+would show only the postings to top-level accounts, which usually means
+none.
+
 Prices
 """"""