.Dd December 13, 2023
.Dt LEDGER 1
.Os
.Sh "نام (NAME)"
.Nm ledger
.Nd ابزار گزارش‌گیری حسابداری دوبل خط فرمان
.Sh "خلاصه دستور (SYNOPSIS)"
.Nm
.Op Ar options
.Op Ar command
.Op Ar arguments
.Sh "توضیحات (DESCRIPTION)"
.Nm
یک ابزار حسابداری خط فرمان مبتنی بر توانمندی و جامعیت حسابداری دوبل (دفترداری دوطرفه) است. این برنامه صرفاً یک ابزار گزارش‌گیری است، به این معنی که هرگز فایل‌های داده‌های شما را تغییر نمی‌دهد، اما مجموعه گسترده‌ای از گزارش‌ها و روش‌های گوناگون را برای سفارشی‌سازی آن‌ها مطابق با نیازهایتان فراهم می‌سازد.
.Sh "دستورات (COMMANDS)"
.Nm
چندین دستور سطح‌بالا را می‌پذیرد که هر یک نوع متفاوتی از گزارش‌های پایه را تولید می‌کنند. بیشتر آن‌ها یک آرگومان
.Ar report-query
را به منظور تعیین مواردی که باید گزارش شوند، دریافت می‌کنند. برای درک نحو یک
.Ar report-query ،
بخش
.Sx QUERIES
را ببینید. در ابتدایی‌ترین حالت، تنها مشخص کردن یک یا چند رشته به‌سادگی گزارشی برای تمامی حساب‌های حاوی آن رشته‌ها تولید می‌کند.
.Pp
اگر هیچ دستوری داده نشود،
.Nm
وارد یک
.Tn REPL
یا حلقه فرمان می‌شود که امکان اجرای چندین دستور روی یک مجموعه داده بدون نیاز به تجزیه مجدد را فراهم می‌سازد.
.Pp
فهرست زیر مجموعه‌ای کامل از دستورات گزارش‌گیری پذیرفته‌شده است:
.Bl -tag -width accounts
.It Ic accounts Oo Ar report-query Oc
فهرست کردن تمام حساب‌ها برای ثبت‌هایی که با
.Ar report-query
مطابقت دارند.
.El
.Bl -tag -width balance
.It Ic balance Oo Ar report-query Oc
چاپ یک گزارش ترازنامه که مجموع مبالغ را برای ثبت‌های منطبق بر
.Ar report-query
و مجموع تجمیعی را برای حساب‌های والد آن حساب‌ها نشان می‌دهد. گزینه‌هایی که بیشتر همراه با این دستور استفاده می‌شوند عبارتند از:
.Bl -tag -compact -width "--collapse (-n)"
.It Fl \-basis Pq Fl B
گزارش بر حسب بهای تمام‌شده پایه، نه مبلغ یا ارزش. این تنها نوع گزارشی است که وقتی هیچ
.Ar report-query
مشخص نشده باشد، تضمین می‌شود همیشه به صفر تراز شود.
تنها نمایش مجموع‌ها برای بالاترین حساب‌ها.
.It Fl \-empty Pq Fl E
نمایش حساب‌هایی که مجموع آن‌ها صفر است.
.It Fl \-flat
به جای نمایش یک درخت سلسله‌مراتبی، گزارش را مسطح می‌کند تا جمع‌های جزئی را تنها برای حساب‌های منطبق بر
.Ar report-query
نشان دهد.
.It Fl \-no-total
حذف مجموع کل خلاصه که در پایین گزارش نشان داده می‌شود.
.El
.Pp
مترادف‌های
.Ic bal
و
.Ic b
نیز پذیرفته می‌شوند.
.It Ic budget Oo Ar report-query Oc
یک گزارش تراز ویژه که شامل سه ستون اضافی است: مبلغ بودجه‌بندی‌شده در طول دوره گزارش، میزان تفاوت هزینه‌کرد با بودجه، و درصد بودجه صرف‌شده (اگر از بودجه فراتر روید از ۱۰۰٪ بیشتر می‌شود). توجه داشته باشید که بودجه‌بندی نیازمند تعریف یک یا چند
.Do
تراکنش دوره‌ای
.Dc
در فایل(های) داده شماست. برای اطلاعات بیشتر به کتابچه راهنما مراجعه کنید.
.It Ic cleared Oo Ar report-query Oc
یک گزارش تراز ویژه که دو ستون اضافی می‌افزاید: مانده تسویه‌شده برای هر حساب، و تاریخ جدیدترین ثبت تسویه‌شده در آن حساب. برای اینکه این حسابداری معنادار باشد، پرچم تسویه باید حداقل روی یک ثبت تنظیم شده باشد. برای اطلاعات بیشتر به کتابچه راهنما مراجعه کنید.
.It Ic commodities Oo Ar report-query Oc
فهرست کردن تمام کالاها (ارزها و دارایی‌ها) برای ثبت‌های منطبق بر
.Ar report-query .
.It Ic convert
خواندن داده‌ها از یک فایل CSV (مقادیر جداشده با کاما) و تولید تراکنش‌های
.Nm .
.It Ic csv Oo Ar report-query Oc
گزارش ثبت‌های منطبق بر
.Ar report-query
در قالب CSV (مقادیر جداشده با کاما). مناسب برای برون‌بری داده‌ها به یک صفحه گسترده جهت تحلیل بیشتر یا نمودارکشی.
.It Ic entry Oo Ar entry-template Oc
تولید و نمایش یک تراکنش جدید با قالب‌بندی درست در
.Nm
از طریق مقایسه
.Ar entry-template
با تراکنش‌های موجود در فایل(های) داده شما. برای اطلاعات بیشتر در خصوص الگوهای پیش‌نویس و استفاده از این دستور برای ایجاد سریع تراکنش‌های جدید، بخش
.Sx ENTRIES
را ببینید.
.Pp
مترادف
.Ic xact
نیز پذیرفته می‌شود.
.It Ic emacs Oo Ar query Oc
خروجی دادن داده‌های ثبت و تراکنش در قالبی که به سادگی توسط ویرایشگر Emacs قابل استفاده باشد، در قالب مجموعه‌ای از ساختارهای Lisp. این دستور توسط حالت ledger-mode در Emacs برای پردازش داده‌های گزارش از
.Nm
استفاده می‌شود.
.It Ic equity Oo Ar report-query Oc
چاپ یک تراکنش با مجموعه‌ای از ثبت‌ها که مجموع‌های جاری حساب‌های منطبق بر
.Ar report-query
را در یک حساب ویژه به نام
.Li Equity:Opening Balances
تراز می‌کند. هدف این گزارش بستن حساب‌ها برای سال قبل است، در حالی که از این ثبت‌های حقوق صاحبان سهام (سرمایه) برای انتقال آن مانده‌ها به دوره بعد استفاده می‌شود.
.It Ic payees Oo Ar report-query Oc
فهرست کردن تمام طرف‌های حساب (دریافت‌کنندگان/پرداخت‌کنندگان) برای ثبت‌های منطبق بر
.Ar report-query .
.It Ic pricemap
تولید فایلی که می‌تواند برای ساخت یک نمودار با ابزار graphviz جهت نمایش رابطه میان کالاها/ارزها در فایل
.Nm
استفاده شود.
.It Ic prices Oo Ar report-query Oc
گزارش قیمت‌ها برای تمامی کالاها/ارزها در ثبت‌های منطبق بر
.Ar report-query .
قیمت‌ها با تفکیک یک روز منفرد گزارش می‌شوند.
.It Ic pricedb Oo Ar report-query Oc
گزارش قیمت‌ها برای تمامی کالاها/ارزها در ثبت‌های منطبق بر
.Ar report-query .
قیمت‌ها با تفکیک ثانیه و با استفاده از همان قالب فایل
.Pa \[ti]/.pricedb
گزارش می‌شوند.
.It Ic print Oo Ar report-query Oc
چاپ کامل تراکنش‌های هر یک از ثبت‌های منطبق با همان قالبی که در یک فایل داده ظاهر می‌شوند. این می‌تواند برای استخراج زیرمجموعه‌هایی از یک فایل
.Nm
جهت انتقال به فایل‌های دیگر استفاده شود.
.It Ic push Oo Ar options Oc
در محیط
.Tn REPL ،
قراردادن مجموعه‌ای از
.Ar options
خط فرمان در پشته، تا بر تمامی گزارش‌های بعدی اعمال شوند.
.It Ic pop
در محیط
.Tn REPL ،
برداشتن تنظیمات گزینه‌هایی که پیش‌تر با
.Sm off
.Ic push
.Sm on
اعمال شده بودند.
.It Ic register Oo Ar report-query Oc
فهرست کردن تمام ثبت‌های منطبق بر
.Ar report-query .
این یکی از رایج‌ترین دستورات است و می‌تواند برای ارائه انواع گزارش‌های مفید استفاده شود. گزینه‌هایی که بیشتر همراه با این دستور استفاده می‌شوند عبارتند از:
.Pp
.Bl -tag -compact -width "--collapse (-n)"
.It Fl \-average Pq Fl A
نمایش میانگین متحرک، به جای مجموع متحرک.
.It Fl \-current Pq Fl c
عدم نمایش ثبت‌های فراتر از روز جاری.
.It Fl \-exchange Qo Ar COMMODITY Oo , Ar COMMODITY, ... Oc Qc Pq Fl X
ارائه تمامی مقادیر بر حسب
.Ar commodity
مشخص‌شده، در صورتی که نرخ تبدیل قیمت قابل تعیین باشد. اگر چند کالا/ارز مشخص شوند، مقادیر مربوط به ارزهای فهرست‌شده به همان صورت باقی می‌مانند و سایرین در نخستین ارز فهرست‌شده‌ای که قابل تبدیل به آن باشند نمایش داده می‌شوند. نرخ‌ها همواره نسبت به تاریخ ثبتی که برای آن محاسبه می‌شوند نمایش می‌یابند. این بدان معناست که یک گزارش
.Ic register
یک گزارش ارزش تاریخی است. برای ارزش‌های جاری، شاید ترجیح داده شود از گزارش
.Ic balance
استفاده شود.
.It Fl \-gain Pq Fl G
نمایش هرگونه سود (یا زیان) در ارزش کالاها/ارزها در طول زمان.
.It Fl \-head Ar number
فقط نمایش به تعداد
.Ar number
از ثبت‌های ابتدایی.
.It Fl \-historical Pq Fl H
ارزش‌گذاری کالاها/ارزها در زمان تحصیل آن‌ها.
.It Fl \-invert
معکوس کردن علامت مبالغ نمایش‌داده‌شده.
.It Fl \-market Pq Fl V
نمایش ارزش‌های جاری بازار برای تمام مبالغ. این مقدار به روشی تا حدی شگفت‌انگیز تعیین می‌شود. احتمالاً استفاده از گزینه
.Fl \-exchange
سرراست‌تر است.
.It Fl \-period Ar time-period Pq Fl p
نمایش ثبت‌ها تنها برای
.Ar time-period
مشخص‌شده.
.It Fl \-related Pq Fl r
نمایش ثبت‌هایی که با موارد نمایش‌داده‌شده مرتبط هستند. این گزینه اثر نمایش
.Qq طرف دیگر
ثبت‌ها را دارد.
.It Fl \-sort Ar value-expression Pq Fl S
مرتب‌سازی ثبت‌ها با ارزیابی
.Ar value-expression
داده‌شده. توجه داشته باشید که فهرستی از عبارت‌های جداشده با کاما مجاز است، که در این حالت هر عبارت مرتب‌سازی به نوبت برای تعیین ترتیب نهایی استفاده می‌شود. برای مثال برای جستجو بر اساس تاریخ و سپس مبلغ:
.Dl ledger reg --sort \[aq]date, amount\[aq]
ترتیب مرتب‌سازی را می‌توان با علامت '-' کنترل کرد. برای مثال برای مرتب‌سازی برعکس زمانی:
.Dl ledger reg --sort \[aq]-date\[aq]
.It Fl \-tail Ar number
فقط نمایش به تعداد
.Ar number
از آخرین ثبت‌ها.
.It Fl \-uncleared Pq Fl U
فقط نمایش ثبت‌های تسویه‌نشده (یعنی اخیر).
.El
.Pp
همچنین چندین گزینه گروه‌بندی وجود دارد که می‌توانند مفید باشند:
.Pp
.Bl -tag -compact -width "--collapse (-n)"
.It Fl \-by-payee Pq Fl P
گروه‌بندی ثبت‌ها بر اساس نام مشترک دریافت‌کنندگان وجه (طرف‌های حساب).
.It Fl \-daily Pq Fl D
گروه‌بندی ثبت‌ها بر اساس روز.
.It Fl \-weekly Pq Fl W
گروه‌بندی ثبت‌ها بر اساس هفته (شروع از یکشنبه‌ها).
.It Fl \-start-of-week Ar day
تنظیم روز شروع هر گزارش گروه‌بندی‌شده بر اساس هفته به
.Ar day
مشخص‌شده.
.It Fl \-monthly Pq Fl M
گروه‌بندی ثبت‌ها بر اساس ماه.
.It Fl \-quarterly
گروه‌بندی ثبت‌ها بر اساس فصل مالی.
.It Fl \-yearly Pq Fl Y
گروه‌بندی ثبت‌ها بر اساس سال.
.It Fl \-days-of-week
گروه‌بندی ثبت‌ها بر پایه روزی از هفته که در آن رخ داده‌اند.
.It Fl \-subtotal Pq Fl s
گروه‌بندی تمام ثبت‌ها با یکدیگر. این بسیار شبیه به مجموع‌های نشان‌داده‌شده در گزارش
.Ic balance
است.
.El
.Pp
مترادف‌های
.Ic reg
و
.Ic r
نیز پذیرفته می‌شوند.
.It Ic select Oo Ar sql-query Oc
فهرست کردن تمام ثبت‌های منطبق بر
.Ar sql-query .
این دستور امکان تولید پرس‌وجوهای شبیه به SQL را فراهم می‌کند، مثلاً:
.Dl Li ledger select date,amount from posts where account=\[ti]/Income/
.It Ic source
تجزیه فایل دفتر روزنامه و بررسی آن برای یافتن خطاها.
.Nm
در صورتی که خطایی یافت نشود، وضعیت موفقیت بازمی‌گرداند.
.It Ic stats Oo Ar report-query Oc
ارائه اطلاعات خلاصه درباره تمام ثبت‌های منطبق بر
.Ar report-query .
این دستور اطلاعاتی از قبیل موارد زیر را فراهم می‌آورد:
.Bl -bullet -offset indent -compact
.It
بازه زمانی تمامی ثبت‌های منطبق
.It
طرف‌های حساب منحصربه‌فرد
.It
حساب‌های منحصربه‌فرد
.It
مجموع ثبت‌ها
.It
ثبت‌های تسویه‌نشده
.It
روزهای گذشته از آخرین ثبت
.It
ثبت‌های ۷ روز گذشته
.It
ثبت‌های ۳۰ روز گذشته
.It
ثبت‌های این ماه
.El
.It Ic xml Oo Ar report-query Oc
خروجی دادن داده‌های مربوط به گزارش جاری در قالب
.Tn XML .
این شامل تمامی حساب‌ها و کالاهای دخیل در گزارش، به همراه ثبت‌ها و تراکنش‌های دربرگیرنده آن‌هاست. برای اطلاعات بیشتر به کتابچه راهنما مراجعه کنید.
.El
.Sh "گزینه‌ها (OPTIONS)"
.Bl -tag -width -indent
.It Fl \-abbrev-len Ar INT
حداقل طولی را که نام یک حساب در صورت جا نشدن در
.Sy account-width
می‌تواند به آن خلاصه شود، تعیین می‌کند. اگر
.Ar INT
صفر باشد، نام حساب از سمت راست بریده می‌شود. اگر
.Ar INT
بزرگتر از
.Sy account-width
باشد، نام حساب از سمت چپ بریده خواهد شد، بدون اینکه هیچ کوتاه‌سازی در نام‌های حساب‌ها به منظور جا شدن در عرض مورد نظر اعمال شود.
.It Fl \-account Ar EXPR
افزودن
.Ar EXPR
به ابتدای تمامی حساب‌های گزارش‌شده. به این معنا که گزینه
.Fl \-account Ar \*q\[aq]Personal\[aq]\*q
عبارت
.Ar Personal:
را اضافه می‌کند و
.Fl \-account Ar \*qtag(\[aq]VAT\[aq])\*q
مقدار برچسب VAT را به ابتدای هر حسابی که در یک گزارش
.Ic balance
یا
.Ic register
گزارش شده است الصاق می‌کند.
.It Fl \-account-width Ar INT
تعیین عرض ستون حساب در گزارش
.Ic register
به میزان
.Ar INT
کاراکتر.
.It Fl \-actual Pq Fl L
گزارش تنها تراکنش‌های واقعی، بدون استفاده از تراکنش‌های خودکار یا مجازی.
.It Fl \-add-budget
تنها نمایش ثبت‌های بودجه‌بندی‌نشده.
.It Fl \-align-intervals
استفاده از ابتدای دوره گزارش به عنوان شروع بازه‌ها، به جای ابتدای هفته، ماه، فصل یا سال.
.It Fl \-amount Ar EXPR Pq Fl t
اعمال عبارت مقداری داده‌شده بر مبلغ ثبت. با استفاده از
.Fl \-amount Ar EXPR
می‌توانید یک تبدیل دلخواه را روی ثبت‌ها اعمال کنید.
.It Fl \-amount-data Pq Fl j
در یک گزارش register تنها تاریخ‌ها و مبلغ ثبت‌ها را چاپ می‌کند. برای برنامه‌های نمودارکشی و صفحات گسترده مفید است.
.It Fl \-amount-width Ar INT
تعیین عرض ستون مبلغ در گزارش
.Ic register
بر حسب تعداد کاراکتر.
.It Fl \-anon
ناشناس‌سازی خروجی دفتر روزنامه، عمدتاً برای ارسال در گزارش خطاها (باگ‌ها).
.It Fl \-ansi
استفاده از رنگ در صورتی که ترمینال از آن پشتیبانی کند. نام مستعار برای
.Fl \-color .
.It Fl \-args-only
نادیده گرفتن فایل‌های پیکربندی آغازین و متغیرهای محیطی برای اجرای
.Nm .
.It Fl \-auto-match
هنگام تولید یک تراکنش ledger از یک فایل CSV با استفاده از دستور
.Ic convert ،
به طور خودکار حسابی از دفتر روزنامه Ledger تطبیق داده شود.
.It Fl \-aux-date
نمایش تاریخ‌های کمکی برای تمامی محاسبات. نام مستعار برای
.Fl \-effective .
.It Fl \-average Pq Fl A
چاپ مقادیر میانگین بر حسب تعداد تراکنش‌ها به جای مجموع‌های متحرک.
.It Fl \-average-lot-prices
گزارش میانگین قیمتی که هر کالا/ارز با آن خریداری شده در یک گزارش تراز.
.It Fl \-balance-format Ar FMT
تعیین قالب مورد استفاده برای گزارش
.Ic balance .
.It Fl \-base
تقلیل کالاهای قابل تبدیل به پایین‌ترین سطح تبدیل؛ برای مثال نمایش زمان بر حسب ثانیه.
.It Fl \-basis Pq Fl B
گزارش بهای تمام‌شده پایه در تمام ثبت‌ها. نام مستعار برای
.Fl \-cost .
.It Fl \-begin Ar DATE Pq Fl b
مشخص کردن تاریخ شروع
.Pq Ar DATE
برای تمامی محاسبات. تراکنش‌های پیش از آن تاریخ نادیده گرفته می‌شوند.
.It Fl \-bold-if Ar EXPR
چاپ کل خط به صورت پررنگ (bold) در صورتی که عبارت مقداری داده‌شده درست (true) باشد.
.It Fl \-budget
تنها نمایش اقلام بودجه‌بندی‌شده. در یک گزارش
.Ic register
این گزینه تراکنش‌های موجود در بودجه را نمایش می‌دهد، و در یک گزارش balance حساب‌های موجود در بودجه را نمایش می‌دهد.
.It Fl \-budget-format Ar FMT
تعیین قالب مورد استفاده برای گزارش
.Ic budget .
.It Fl \-by-payee Pq Fl P
گروه‌بندی ثبت‌ها در گزارش register بر اساس نام مشترک طرف‌های حساب (دریافت‌کنندگان وجه).
.It Fl \-check-payees
فعال‌سازی بررسی دقیق و سخت‌گیرانه برای طرف‌های حساب و همچنین حساب‌ها، کالاها و برچسب‌ها.
.It Fl \-cleared Pq Fl C
نمایش تنها ثبت‌های تسویه‌شده.
.It Fl \-cleared-format Ar FMT
تعیین قالب مورد استفاده برای گزارش
.Ic cleared .
.It Fl \-collapse Pq Fl n
چاپ تنها حساب‌های سطح بالا.
.It Fl \-collapse-if-zero
بستن و جمع کردن نمایش حساب تنها در صورتی که مانده آن صفر باشد.
.It Fl \-color
استفاده از رنگ در صورتی که ترمینال از آن پشتیبانی کند. نام مستعار برای
.Fl \-ansi .
.It Fl \-columns Ar INT
تنظیم عرض گزارش
.Ic register
به اندازه
.Ar INT
کاراکتر. به طور پیش‌فرض
.Nm
از تمامی ستون‌های در دسترس ترمینال شما استفاده خواهد کرد.
.It Fl \-cost
گزارش بهای تمام‌شده پایه در تمام ثبت‌ها. نام مستعار برای
.Fl \-basis .
.It Fl \-count
هدایت
.Nm
به گزارش تعداد اقلام، زمانی که به دستورات
.Ic commodities ،
.Ic accounts
یا
.Ic payees
پیوست شود.
.It Fl \-csv-format Ar FMT
قالب‌بندی گزارش
.Ic csv
مطابق با
.Ar FMT .
.It Fl \-current Pq Fl c
شکل کوتاه برای
.Fl \-limit Ar "\[aq]date <= today\[aq]" .
.It Fl \-daily Pq Fl D
شکل کوتاه برای
.Fl \-period Ar daily .
.It Fl \-date Ar EXPR
تبدیل تاریخ تراکنش با استفاده از
.Ar EXPR .
.It Fl \-date-format Ar DATEFMT Pq Fl y
چاپ تاریخ‌ها با استفاده از
.Ar DATEFMT .
برای جزئیات در خصوص نحو رشته قالب به
.Xr strftime 3
مراجعه کنید.
.It Fl \-datetime-format Ar DATETIMEFMT
چاپ تاریخ و زمان با استفاده از
.Ar DATETIMEFMT .
برای جزئیات در خصوص نحو رشته قالب به
.Xr strftime 3
مراجعه کنید.
.It Fl \-date-width Ar INT
تعیین عرض ستون تاریخ در گزارش
.Ic register
بر حسب تعداد کاراکتر.
.It Fl \-day-break
تفکیک ثبت‌های ورودی timelog در گزارش
.Ic register
که چند روز را در بر می‌گیرند بر اساس روز.
.It Fl \-days-of-week
گروه‌بندی تراکنش‌ها بر اساس روزهای هفته. نام مستعار برای
.Fl \-dow .
.It Fl \-dc
نمایش دفتر روزنامه یا تراز در قالب بدهکار/بستانکار. اگر از
.Fl \-dc
همراه با هر یک از دستورات
.Ic register
یا
.Ic balance
استفاده کنید، ستون‌های جداگانه‌ای برای بدهکارها و بستانکارها دریافت خواهید کرد.
.It Fl \-debug Ar STR
اگر
.Nm
همراه با گزینه‌های اشکال‌زدایی ساخته شده باشد، این گزینه داده‌های اضافی را در طول اجرا فراهم می‌کند.
.It Fl \-decimal-comma
هدایت
.Nm
به تجزیه دفاتر روزنامه با استفاده از ویرگول استاندارد اروپایی به عنوان ممیز اعشاری، به جای نقطه.
.It Fl \-depth Ar INT
محدود کردن عمق حساب‌های نمایش‌داده‌شده در گزارش‌های balance و register. هر حسابی با عمق بیشتر درون والد خود در سطح مشخص‌شده جمع می‌شود. برای مثال با
.Fl \-depth Ar 2
حساب
.Sy Expenses:Entertainment:Dining
برای نمایش درون
.Sy Expenses:Entertainment
جمع می‌شود. نکته حائز اهمیت این است که این یک گزاره نمایشی است، به این معنی که تنها بر نمایش اثر می‌گذارد نه محاسبات مجموع کل.
.It Fl \-detail
مربوط به دستور
.Ic convert .
مترادف با گزینه
.Fl \-rich-data .
.It Fl \-deviation
گزارش انحراف هر ثبت از میانگین. تنها در گزارش‌های
.Ic register No و Ic prices
معنادار است.
.It Fl \-display Ar EXPR Pq Fl d
نمایش خطوطی که عبارت
.Ar EXPR
را برآورده می‌سازند.
.It Fl \-display-amount Ar EXPR
اعمال یک تبدیل روی مبلغ
.Em نمایش‌داده‌شده .
این کار پس از انجام محاسبات رخ می‌دهد.
.It Fl \-display-total Ar EXPR
اعمال یک تبدیل روی مجموع
.Em نمایش‌داده‌شده .
این کار پس از انجام محاسبات رخ می‌دهد.
.It Fl \-dow
گروه‌بندی تراکنش‌ها بر اساس روزهای هفته. نام مستعار برای
.Fl \-days-of-week .
.It Fl \-download
باعث می‌شود مظنه‌ها در صورت نیاز به طور خودکار با اجرای اسکریپتی به نام
.Em getquote
و انتظار اینکه آن اسکریپت مقداری قابل فهم برای
.Nm
بازگرداند، دانلود شوند. یک پیاده‌سازی نمونه از اسکریپت
.Em getquote
که با پرل پیاده‌سازی شده در توزیع برنامه ارائه شده است. مظنه‌های قیمتی دانلودشده سپس به پایگاه داده قیمت اضافه می‌شوند که معمولاً با متغیر محیطی
.Ev LEDGER_PRICE_DB
مشخص می‌گردد.
.It Fl \-effective
نمایش تاریخ‌های کمکی برای تمامی محاسبات. نام مستعار برای
.Fl \-aux-date .
.It Fl \-empty Pq Fl E
گنجاندن حساب‌های خالی در گزارش.
.It Fl \-end Ar DATE Pq Fl e
محدود کردن گزارش به گونه‌ای که تراکنش‌های در تاریخ یا پس از
.Ar DATE
در نظر گرفته نشوند.
.It Fl \-equity
مربوط به دستور
.Ic equity .
مانده‌های جاری حساب را در قالب یک گزارش register ارائه می‌دهد.
.It Fl \-exact
گزارش ابتدا و انتهای دوره‌ها بر اساس تاریخ نخستین و آخرین ثبت رخ‌داده در آن دوره.
.It Fl \-exchange Qo Ar COMMODITY Oo , Ar COMMODITY, ... Oc Qc Pq Fl X
نمایش مقادیر بر حسب
.Ar COMMODITY
مشخص‌شده. اگر چند کالا/ارز مشخص شوند، مقادیر مربوط به کالاهای فهرست‌شده همان‌گونه باقی می‌مانند، و سایرین در نخستین کالای فهرست‌شده‌ای که قابل تبدیل به آن باشند نمایش داده می‌شوند.
.It Fl \-file Ar FILE Pq Fl f
خواندن داده‌های دفتر روزنامه از
.Ar FILE .
.It Fl \-first Ar INT
چاپ اولین
.Ar INT
ورودی. متضاد
.Fl \-last Ar INT .
نام مستعار برای
.Fl \-head .
.It Fl \-flat
اجبار به استفاده از نام کامل حساب‌ها در گزارش balance. گزارش balance از یک درخت تورفته استفاده نخواهد کرد.
.It Fl \-force-color
خروجی دادن کدهای رنگی TTY حتی اگر TTY از آن‌ها پشتیبانی نکند. برای پایانه‌هایی که قابلیت‌های خود را به درستی اعلام نمی‌کنند مفید است.
.It Fl \-force-pager
مجبور کردن
.Nm
به صفحه‌بندی خروجی خود.
.It Fl \-forecast-while Ar EXPR
ادامه پیش‌بینی تا زمانی که
.Ar VEXPR
درست باشد. نام مستعار برای
.Fl \-forecast .
.It Fl \-forecast-years Ar INT
پیش‌بینی حداکثر تا
.Ar INT
سال در آینده.
.It Fl \-format Ar FMT Pq Fl F
استفاده از رشته قالب داده‌شده
.Ar FMT
برای چاپ خروجی.
.It Fl \-gain Pq Fl G
گزارش سود یا زیان خالص برای کالاهایی که تاریخچه قیمت دارند.
.It Fl \-generated
گنجاندن ثبت‌های خودکار تولیدشده (مانند ثبت‌های ناشی از تراکنش‌های خودکار) در گزارش، در مواردی که معمولاً آن‌ها را نمی‌خواهید.
.It Fl \-group-by Ar EXPR
گروه‌بندی تراکنش‌ها با یکدیگر در گزارش
.Ic register .
.Ar EXPR
می‌تواند هر چیزی باشد، هرچند رایج‌ترین آن‌ها
.Ar payee
یا
.Ar commodity
است. تابع
.Fn tag
نیز در اینجا مفید است.
.It Fl \-group-title-format Ar FMT
تنظیم قالب برای هدرهایی که بخش‌های گزارش را در یک گزارش گروه‌بندی‌شده از هم جدا می‌کنند. تنها در یک گزارش register همراه با
.Fl \-group-by Ar EXPR
اثر دارد.
.It Fl \-hashes Ar ALGO
ثبت هش هر تراکنش در مقدار فراداده
.Ar Hash ،
مطابق با الگوریتم درهم‌سازی ارائه‌شده توسط آرگومان
.Ar ALGO .
الگوریتم‌های پشتیبانی‌شده عبارتند از
.Ar sha512
یا
.Ar sha512_half
که در آن هر دو از SHA512 استفاده می‌کنند، اما دومی تنها نیمه اول مقدار هش را ذخیره می‌کند.
.Pp
اگر مقدار فراداده
.Ar Hash
به صورت صریح ارائه شده باشد و با آنچه که باید تولید می‌شد مطابقت نداشته باشد، یک خطا گزارش می‌شود. هش‌ها به ورودی‌های پیشین وابسته هستند، به طوری که تنظیم یک مقدار هش منفرد برای تضمین شکل کل تاریخچه منتهی به آن ورودی کافی است.
.It Fl \-head Ar INT
چاپ اولین
.Ar INT
ورودی. متضاد
.Fl \-tail Ar INT .
نام مستعار برای
.Fl \-first
.It Fl \-help
چاپ این صفحه راهنما.
.It Fl \-immediate
ارزیابی محاسبات به صورت بلادرنگ به جای ارزیابی تنبل (lazy).
.It Fl \-import Ar FILE
وارد کردن
.Ar FILE
به عنوان ماژول پایتون.
.It Fl \-init-file Ar FILE Pq Fl i
خواندن
.Ar FILE
پیش از هر فایل دیگر
.Nm .
این فایل نباید شامل هیچ ثبتی باشد، اما می‌تواند شامل تنظیمات گزینه‌ها باشد. برای تعیین گزینه‌ها در فایل پیکربندی آغازین، از همان نحو خط فرمان استفاده کنید، اما هر گزینه را در خطی جداگانه قرار دهید.
.It Fl \-inject Ar STR
استفاده از مبالغ
.Ar STR
در محاسبات. در صورتی که می‌دانید مبلغ یک تراکنش چه باید باشد، اما تراکنش واقعی مقدار نادرستی دارد، می‌توانید از فراداده
.Ar STR
برای مشخص کردن مبلغ مورد انتظار استفاده کنید.
.It Fl \-input-date-format Ar DATEFMT
تعیین قالب تاریخ ورودی برای ثبت‌های دفتر روزنامه.
.It Fl \-invert
تغییر علامت تمام مقادیر گزارش‌شده.
.It Fl \-last Ar INT .
گزارش تنها به تعداد
.Ar INT
از آخرین ورودی‌ها. متضاد
.Fl \-first Ar INT .
تنها در یک گزارش register مفید است. نام مستعار برای
.Fl \-tail .
.It Fl \-leeway Ar INT Pq Fl Z
نام مستعار برای
.Fl \-price-exp .
.It Fl \-limit Ar EXPR Pq Fl l
محدود کردن ثبت‌ها در محاسبات.
.It Fl \-lisp-date-format Ar FORMAT
تعیین قالب برای تاریخ‌ها در خروجی lisp. پیش‌فرض از قالب زمان Emacs Lisp استفاده می‌کند. گزینه‌های دیگر عبارتند از
.Ql seconds
(ثانیه‌های مبدا یونیکس) یا یک رشته قالب strftime مانند
.Ql %Y-%m-%d .
.It Fl \-lot-dates
گزارش تاریخی که هر کالا/ارز در یک گزارش تراز در آن خریداری شده است.
.It Fl \-lot-notes
گزارش برچسب پیوست‌شده به هر کالا در یک گزارش تراز.
.It Fl \-lot-prices
گزارش قیمتی که هر کالا در یک گزارش تراز با آن خریداری شده است.
.It Fl \-lots
گزارش تاریخ و قیمتی که هر کالا در یک گزارش تراز با آن خریداری شده است.
.It Fl \-lots-actual
حفظ یکتایی کالاها به طوری که در طول گزارش‌گیری بدون چاپ حاشیه‌نویسی‌های لات با یکدیگر ادغام نشوند.
.It Fl \-market Pq Fl V
استفاده از آخرین ارزش بازار برای تمامی کالاها/ارزها.
.It Fl \-master-account Ar STR
افزودن
.Ar STR
به ابتدای تمامی نام‌های حساب.
.It Fl \-meta Ar STR
در گزارش register، تراکنش را با مقدار برچسب داده‌شده
.Ar STR
آغاز می‌کند.
.It Fl \-meta-width Ar INT
تعیین عرض ستون Meta استفاده‌شده برای گزینه‌های
.Fl \-meta Ar TAG .
.It Fl \-monthly Pq Fl M
شکل کوتاه برای
.Fl \-period Ar monthly .
.It Fl \-no-aliases
نام‌های مستعار کاملاً نادیده گرفته می‌شوند.
.It Fl \-no-color
حذف هرگونه خروجی رنگی TTY.
.It Fl \-no-pager
غیرفعال کردن صفحه‌بندی در خروجی TTY.
.It Fl \-no-revalued
جلوگیری از نمایش ثبت‌های
<Revalued>
توسط
.Nm .
.It Fl \-no-rounding
عدم چاپ ثبت‌های
.Qq Li <Adjustment> .
توجه داشته باشید که این گزینه غالباً باعث می‌شود جمع متحرک درست درنیاید! کاربرد اصلی آن برای گزارش‌های
.Fl \-amount-data Pq Fl j
و
.Fl \-total-data Pq Fl J
است.
.It Fl \-no-titles
حذف خروجی عنوان‌های گروه.
.It Fl \-no-total
عدم چاپ خط مجموع نهایی در یک گزارش تراز.
.It Fl \-now Ar DATE
استفاده از
.Ar DATE
به عنوان تاریخ جاری. این گزینه بر خروجی هنگام استفاده از
.Fl \-period ،
.Fl \-begin ،
.Fl \-end
یا
.Fl \-current
برای تصمیم‌گیری درباره اینکه کدام تاریخ‌ها در گذشته یا آینده قرار دارند اثر می‌گذارد.
.It Fl \-only Ar EXPR
این یک گزاره ثبت است که پس از اجرای تبدیلات مشخصی مانند گردآوری دوره‌ای اعمال می‌شود.
.It Fl \-options
نمایش گزینه‌های فعال برای این فراخوانی
.Nm ،
به همراه مقادیر آن‌ها و منبع آن مقادیر.
.It Fl \-output Ar FILE Pq Fl o
هدایت مجدد خروجی
.Nm
به
.Ar FILE .
.It Fl \-pager Ar STR
استفاده از
.Ar STR
به عنوان برنامه صفحه‌بندی (pager).
.It Fl \-payee
تنظیم یک عبارت مقداری برای قالب‌بندی طرف حساب. در گزارش
.Ic register
این گزینه از داشتن تاریخ و طرف حساب برای ورودی دوم در هر تراکنش جلوگیری می‌کند.
.It Fl \-payee-width Ar INT
تنظیم تعداد ستون‌های اختصاص‌یافته به طرف حساب در گزارش register به
.Ar INT .
.It Fl \-pedantic
حساب‌ها، برچسب‌ها یا کالاهایی که از پیش اعلان نشده باشند موجب خطا خواهند شد.
.It Fl \-pending
استفاده تنها از ثبت‌هایی که به عنوان در انتظار (pending) علامت‌گذاری شده‌اند.
.It Fl \-percent Pq Fl %
محاسبه مقدار درصدی هر حساب در یک گزارش تراز. تنها برای حساب‌هایی کار می‌کند که دارای یک کالا/ارز منفرد باشند.
.It Fl \-period Ar PERIOD Pq Fl p
تعریف یک عبارت دوره که بازه زمانی حسابرسی تراکنش‌ها را تعیین می‌کند. برای یک گزارش
.Ic register
تنها تراکنش‌هایی که عبارت دوره را برآورده کنند نمایش داده می‌شوند. برای یک گزارش تراز تنها آن تراکنش‌ها در مانده‌های نهایی محاسبه خواهند شد.
.It Fl \-period-sort
مرتب‌سازی ثبت‌ها در درون تراکنش‌ها با استفاده از عبارت مقداری داده‌شده.
.It Fl \-permissive
نادیده گرفتن گزاره‌های بررسی صحت تراز (assertions).
.It Fl \-pivot Ar TAG
تولید گزارش تراز محوری
.Qq پیرامون
برچسب داده‌شده
.Ar TAG .
.It Fl \-plot-amount-format Ar FMT
تعیین قالب خروجی برای رسم نمودار داده‌های مبلغ.
.It Fl \-plot-total-format Ar FMT
تعیین قالب خروجی برای رسم نمودار داده‌های مجموع.
.It Fl \-prepend-format Ar FMT
افزودن
.Ar FMT
به ابتدای هر خط از خروجی.
.It Fl \-prepend-width Ar INT
رزرو کردن
.Ar INT
فاصله در ابتدای هر خط از خروجی.
.It Fl \-price Pq Fl I
استفاده از قیمت خرید کالا برای انجام محاسبات.
.It Fl \-price-db Ar FILE
.It Fl \-price-exp Ar INT Pq Fl Z
تنظیم میزان تازگی مورد انتظار برای مظنه‌های قیمت، به میزان
.Ar INT
ساعت. به این معنا که اگر آخرین مظنه شناخته‌شده برای هر کالایی قدیمی‌تر از این مقدار باشد، و اگر
.Fl \-download
در حال استفاده باشد، آنگاه اینترنت مجدداً برای دریافت قیمت جدیدتر بررسی خواهد شد. در غیر این صورت، قیمت پیشین همچنان به اندازه کافی تازه در نظر گرفته می‌شود.
نام مستعار برای
.Fl \-leeway .
.It Fl \-prices-format Ar FMT
تنظیم قالب برای گزارش
.Ic prices .
.It Fl \-pricedb-format Ar FMT
تنظیم قالب مورد انتظار برای فایل قیمت‌های تاریخی.
.It Fl \-primary-date
نمایش تاریخ‌های اولیه برای تمامی محاسبات. نام مستعار برای
.Fl \-actual-dates .
.It Fl \-quantity Pq Fl O
گزارش مجموع کالاها (این حالت پیش‌فرض است).
.It Fl \-quarterly
شکل کوتاه برای
.Fl \-period Ar quarterly .
.It Fl \-raw
در گزارش
.Ic print ،
تراکنش‌ها دقیقاً با همان نحوی که توسط کاربر در فایل داده‌ها مشخص شده نمایش داده شوند. هیچ‌گونه دستکاری یا تفسیر انجام نشود. برای تمیزکاری‌های جزئی مانند تراز کردن مبالغ می‌تواند مفید باشد.
.It Fl \-real Pq Fl R
حسابداری تنها با استفاده از تراکنش‌های واقعی و نادیده گرفتن تراکنش‌های مجازی و خودکار.
.It Fl \-recursive-aliases
باعث می‌شود
.Nm
تلاش کند نام‌های مستعار را به صورت بازگشتی گسترش دهد، یعنی نتیجه گسترش قبلی را مجدداً گسترش دهد، تا زمانی که دیگر هیچ گسترشی قابل اعمال نباشد.
.It Fl \-register-format Ar FMT
تعیین قالب خروجی برای گزارش
.Ic register .
.It Fl \-related Pq Fl r
در گزارش register حساب مرتبط را نشان می‌دهد. این همان
.Em طرف دیگر
تراکنش است.
.It Fl \-related-all
نمایش تمام ثبت‌ها در یک تراکنش، مشابه
.Fl \-related
اما نمایش هر دو طرف هر تراکنش.
.It Fl \-revalued
گزارش اختلاف در مقادیر برای گزارش‌های دستی از طریق درج ثبت‌های
<Revalued> .
این حالت هنگام استفاده از گزینه
.Fl \-exchange Pq Fl X
یا
.Fl \-market Pq Fl V
به صورت ضمنی فعال می‌شود.
.It Fl \-revalued-only
نمایش تنها ثبت‌های
<Revalued> .
.It Fl \-revalued-total
نمایش مجموع ثبت‌های بازتخمین‌شده به عنوان جمع متحرک، که برای نمایش سرمایه تحقق‌نیافته در یک گزارش سود/زیان کاربرد دارد.
.It Fl \-rich-data
هنگام تولید تراکنش ledger از یک فایل CSV با استفاده از دستور
.Ic convert ،
فراداده‌های CSV، Imported و UUID اضافه شوند.
.It Fl \-seed Ar INT
تنظیم بذر تصادفی روی
.Ar INT
برای دستور
.Ic generate .
به عنوان بخشی از آزمون‌های توسعه استفاده می‌شود.
.It Fl \-script Ar FILE
اجرای یک اسکریپت
.Nm .
.It Fl \-sort Ar EXPR Pq Fl S
مرتب‌سازی گزارش register بر اساس عبارت مقداری
.Ar EXPR .
.\".It Fl \-sort-all Ar EXPR
.It Fl \-sort-xacts
مرتب‌سازی ثبت‌ها در درون تراکنش‌ها با استفاده از عبارت مقداری داده‌شده.
.It Fl \-start-of-week Ar STR
استفاده از
.Ar STR
به عنوان روز خاصی از هفته برای شروع، هنگام استفاده از گزینه
.Fl \-weekly .
مقدار
.Ar STR
می‌تواند نام روزها، مخفف آن‌ها مانند
.Qq Mon ،
یا شماره روز هفته با شروع از 0 برای یکشنبه باشد.
.It Fl \-sort-all
مرتب‌سازی تمام حساب‌ها و کالاها.
.It Fl \-strict
حساب‌ها، برچسب‌ها یا کالاهایی که پیش‌تر اعلان نشده باشند موجب هشدار خواهند شد.
.It Fl \-subtotal Pq Fl s
گزارش register به عنوان یک زیرمجموع واحد.
.It Fl \-tail Ar INT
گزارش تنها به تعداد
.Ar INT
از آخرین ورودی‌ها. تنها در گزارش register مفید است. نام مستعار برای
.Fl \-last Ar INT .
.It Fl \-time-colon
نمایش مقدار برای کالاهای مبتنی بر ثانیه به صورت ساعت و دقیقه. بنابراین 8100s به جای 2.25h به صورت 2:15h نمایش داده خواهد شد.
.It Fl \-time-report
افزودن دو ستون به گزارش
.Ic balance
برای نمایش زودترین زمان‌های ورود و خروج مربوط به ثبت‌های timelog.
.It Fl \-total Ar EXPR Pq Fl T
تعریف یک عبارت مقداری برای محاسبه مجموع در گزارش‌ها.
.It Fl \-total-data Pq Fl J
نمایش تنها تاریخ‌ها و مجموع‌ها برای قالب‌بندی خروجی جهت رسم نمودارها.
.It Fl \-total-width Ar INT
تنظیم عرض فیلد مجموع در گزارش register.
.It Fl \-trace Ar INT
فعال‌سازی ردیابی (trace). آرگومان
.Ar INT
سطح ردیابی مورد نظر را مشخص می‌کند.
.It Fl \-truncate Ar STR
مشخص می‌کند در صورتی که محتوای ستون‌ها از عرض آن‌ها بیشتر شود، بریدگی چگونه باید صورت گیرد. مقادیر معتبر برای
.Ar STR
عبارتند از
.Ar leading ،
.Ar middle
و
.Ar trailing .
حالت پیش‌فرض هوشمندانه‌تر از هر سه تای این‌هاست، چرا که زیرنام‌های موجود در نام حساب را در نظر می‌گیرد (این شیوه
.Qq abbreviate
نامیده می‌شود).
.It Fl \-unbudgeted
نمایش تنها ثبت‌های بودجه‌بندی‌نشده.
.It Fl \-uncleared Pq Fl U
استفاده تنها از تراکنش‌های تسویه‌نشده در محاسبات و گزارش‌ها.
.It Fl \-unrealized
نمایش حساب‌های سود و زیان تحقق‌نیافته تولیدشده در گزارش balance.
.It Fl \-unrealized-gains
اجازه به کاربر برای تعیین اینکه چه نام حسابی باید برای سودهای تحقق‌نیافته استفاده شود. پیش‌فرض
.Sy "Equity:Unrealized Gains"
است. اغلب در فایل پیکربندی آغازین برای تغییر پیش‌فرض تنظیم می‌شود.
.It Fl \-unrealized-losses
اجازه به کاربر برای تعیین اینکه چه نام حسابی باید برای زیان‌های تحقق‌نیافته استفاده شود. پیش‌فرض
.Sy "Equity:Unrealized Losses"
است. اغلب در فایل پیکربندی آغازین برای تغییر پیش‌فرض تنظیم می‌شود.
.It Fl \-unround
انجام تمام محاسبات بدون گرد کردن و نمایش نتایج با دقت کامل.
.It Fl \-values
نمایش مقادیر استفاده‌شده توسط هر برچسب در صورت استفاده ترکیبی با دستور
.Ic tags .
.It Fl \-value-expr Ar EXPR
تنظیم یک حاشیه‌نویسی عبارت مقداری سراسری.
.It Fl \-verbose
چاپ اطلاعات با جزئیات کامل درباره اجرای
.Nm .
.It Fl \-verify
فعال‌سازی بررسی‌های صحت مضاعف (assertions) در طول زمان اجرا. این کار باعث کاهش چشمگیر سرعت می‌شود. هنگام ترکیب با
.Fl \-debug Ar CODE ،
برنامه
.Nm
اطلاعات ردیابی حافظه تولید خواهد کرد.
.It Fl \-verify-memory
بررسی اینکه هر شیء ایجادشده به درستی تخریب شود. این گزینه تنها برای اهداف اشکال‌زدایی است.
.It Fl \-version
چاپ اطلاعات نسخه و خروج.
.It Fl \-weekly Pq Fl W
شکل کوتاه برای
.Fl \-period Ar weekly .
.It Fl \-wide Pq Fl w
فرض ۱۳۲ ستون به جای عرض پایانه (TTY).
.It Fl \-yearly Pq Fl Y
شکل کوتاه برای
.Fl \-period Ar yearly .
.El
.Sh "پیش‌دستورات (PRE-COMMANDS)"
پیش‌دستورات زمانی سودمند هستند که مطمئن نیستید یک دستور یا گزینه چگونه کار خواهد کرد. تفاوت میان یک پیش‌دستور و یک دستور معمولی در این است که پیش‌دستورات فایل داده‌های دفتر روزنامه را کاملاً نادیده می‌گیرند و فایل پیکربندی آغازین کاربر نیز خوانده نمی‌شود.
.Bl -tag -width -indent
.It Ic args No / Ic query
ارزیابی آرگومان‌های داده‌شده و گزارش نحوه تفسیر آن توسط
.Nm
در برابر تراکنش مدل زیر:
.Bd -literal -offset indent
2004/05/27 Book Store
    ; This note applies to all postings. :SecondTag:
    Expenses:Books                 20 BOOK @ $10
    ; Metadata: Some Value
    ; Typed:: $100 + $200
    ; :ExampleTag:
    ; Here follows a note describing the posting.
    Liabilities:MasterCard        $-200.00
.Ed
.It Ic eval
ارزیابی عبارت مقداری داده‌شده در برابر تراکنش مدل.
.It Ic format
چاپ جزئیات نحوه استفاده
.Nm
از توصیف قالب‌بندی ارائه‌شده و اعمال آن در برابر یک تراکنش مدل.
.It Ic parse No / Ic expr
چاپ جزئیات نحوه استفاده
.Nm
از توصیف عبارت مقداری داده‌شده و اعمال آن در برابر یک تراکنش مدل.
.It Ic generate
تولید تصادفی داده‌های معتبر از دید نحوی در
.Nm
از روی یک بذر (seed). توسط سامانه GenerateTests برای آزمون‌های توسعه استفاده می‌شود.
.It Ic period
ارزیابی دوره داده‌شده و گزارش نحوه تفسیر آن توسط
.Nm .
.\".It Ic script
.It Ic template
نمایش الگوی درجی که دستور
.Ic xact
تولید می‌کند. این یک دستور اشکال‌زدایی است.
.El
.Sh "پرس‌وجوها (QUERIES)"
نحو عبارات پرس‌وجوی گزارش‌گیری می‌تواند تا حدی پیچیده باشد. این نحو مجموعه‌ای از عبارات پرس‌وجو است که عملگر ضمنی OR میان آن‌ها برقرار است. عبارات زیر پذیرفته می‌شوند:
.Bl -tag -width "term and term"
.It Ar regex
یک رشته ساده به عنوان یک عبارت باقاعده (PCRE) در نظر گرفته می‌شود که با نام کامل حساب مطابقت داده می‌شود. بنابراین برای گزارش تراز جاری تمام دارایی‌ها و بدهی‌ها، می‌توانید از دستور زیر استفاده کنید:
.Pp
.Dl ledger bal asset liab
.It Ic payee Ar regex Pq Ic \&@ Ns Ar regex
پرس‌وجو بر پایه طرف حساب (دریافت‌کننده وجه)، به جای حساب.
.It Ic tag Ar regex Pq Ic \&% Ns Ar regex
پرس‌وجو بر پایه برچسب‌ها.
.It Ic note Ar regex Pq Ic \&= Ns Ar regex
پرس‌وجو روی هر موردی که در یادداشت یک قلم یافت شود.
.It Ic code Ar regex Pq Ic \&# Ns Ar regex
پرس‌وجو بر پایه کد اختیاری تراکنش (که می‌تواند هر رشته دلخواه کاربر باشد).
.It Ar term Cm and Ar term
عبارات پرس‌وجو با یک عملگر ضمنی OR به هم متصل می‌شوند. می‌توانید با استفاده از کلمه کلیدی
.Cm and
این حالت را به AND تغییر دهید. به عنوان مثال، برای نمایش هزینه‌های خوراک رخ‌داده در Shakee's Pizza، می‌توانید بگویید:
.Pp
.Dl Li ledger reg food and @Shakee
.It Ar term Cm or Ar term
هنگامی که می‌خواهید صریح‌تر عمل کنید، از عملگر OR استفاده نمایید.
.It Ic show
.It Cm not Ar term
معکوس کردن معنای منطقی عبارت پس از آن. این عملگر می‌تواند همراه با پرانتزها اثر بسیار مفیدی داشته باشد:
.Pp
.Dl Li ledger reg food and @Shakee and not dining
.It \&( Ar term No \&)
اگر مایلید عملگرهای OR و AND را با یکدیگر ترکیب کنید، اغلب احاطه کردن واحدهای منطقی با پرانتز کمک‌کننده است. \fBنکته\fR: به دلیل شیوه تفسیر پرانتزها در برخی پوسته‌ها، همواره باید آن‌ها را اسکیپ کنید:
.Pp
.Dl Li ledger bal \e( assets or liab \e) and not food
.El
.Sh "عبارت‌ها (EXPRESSIONS)"
.Bl -tag -width "partial_account"
.It Fn abs value
بازگرداندن قدر مطلق مقدار داده‌شده
.Pq Ar value .
.It Sy account
بازگرداندن حساب مربوط به ثبت.
.It Sy account_base
بازگرداندن حساب پایه، یعنی هر آنچه پس از آخرین جداکننده حساب ':' قرار دارد.
.\".It Sy account_amount
.It Sy actual
.\" Is there a difference between real and actual?
بازگرداندن درست (true) در صورتی که تراکنش واقعی باشد، یعنی یک تراکنش خودکار یا مجازی نباشد؛ و نادرست (false) در غیر این صورت.
.It Sy amount
بازگرداندن مبلغ ثبت.
.It Sy amount_expr
بازگرداندن مبلغ محاسبه‌شده ثبت با توجه به گزینه
.Fl \-amount .
.It Fn ansify_if value color bool
ارائه مقدار داده‌شده
.Pq Ar value
به صورت یک رشته، با اعمال کدهای گریز مناسب ANSI برای نمایش آن در رنگ
.Pq Ar color
مشخص‌شده در صورتی که
.Ar bool
درست باشد. این تابع معمولاً مقدار گزینه
.Fl \-color
را بررسی می‌کند، به عنوان مثال:
.Dl Li ansify_if(amount, "blue", options.color)
.It Sy beg_line
شماره خطی که ورودی مربوط به ثبت در آن آغاز می‌شود.
.It Sy beg_pos
موقعیت کاراکتری که ورودی مربوط به ثبت در آن آغاز می‌شود.
.\".It Sy calculated
.It Fn ceiling value
بازگرداندن عدد صحیح بعدی مقدار
.Pq Ar value
به سمت بی‌نهایت مثبت (سقف).
.It Sy cleared
بازگرداندن درست در صورتی که ثبت تسویه شده باشد؛ و نادرست در غیر این صورت.
.It Sy code
بازگرداندن کد تراکنش، رشته‌ای که میان پرانتزها پس از تاریخ قرار دارد.
.\".It Sy comment
.It Fn commodity value
بازگرداندن کالا/ارز مقدار
.Pq Ar value
یا مبلغ ثبت در زمانی که
.Ar value
مشخص نشده باشد.
.\".It Sy cost
.\".It Sy count
.It Sy date
بازگرداندن تاریخ ثبت.
.\".It Sy depth
.\".It Sy depth_spacer
.\".It Sy display_amount
.\".It Sy display_total
.It Sy end_line
شماره خطی که ورودی مربوط به ثبت در آن پایان می‌یابد.
.It Sy end_pos
موقعیت کاراکتری که ورودی مربوط به ثبت در آن پایان می‌یابد.
.It Fn floor value
بازگرداندن عدد صحیح بعدی مقدار
.Pq Ar value
به سمت بی‌نهایت منفی (کف).
.It Sy filename
نام فایل داده
.Nm
که ثبت از آن استخراج شده است.
.It Fn format string
ارزیابی
.Ar string
به عنوان قالب درست مانند گزینه
.Fl \-format .
.It Fn format_date date format
بازگرداندن تاریخ
.Pq Ar date
به صورت یک رشته با استفاده از قالب
.Pq Ar format .
برای جزئیات رشته قالب به
.Xr strftime 3
مراجعه کنید.
.It Fn format_datetime datetime format
بازگرداندن تاریخ و زمان
.Pq Ar datetime
به صورت یک رشته با استفاده از قالب
.Pq Ar format .
برای جزئیات رشته قالب به
.Xr strftime 3
مراجعه کنید.
.It Fn get_at seq index
بازگرداندن مقدار در اندیس
.Pq Ar index
از دنباله
.Pq Ar seq .
استفاده داخلی برای ساخت گزارش‌های گوناگون.
.It Fn has_meta tag
بازگرداندن درست در صورتی که ثبت دارای فراداده‌ای با نام
.Ar tag
باشد؛ و نادرست در غیر این صورت.
.It Fn has_tag tag
بازگرداندن درست در صورتی که ثبت دارای فراداده‌ای با نام
.Ar tag
باشد؛ و نادرست در غیر این صورت.
.It Fn is_seq value
بازگرداندن درست در صورتی که
.Ar value
یک دنباله باشد. استفاده داخلی.
.It Fn join value
جایگزینی تمامی خطوط جدید در
.Ar value
با
.Li \en .
.It Fn justify value first_width latter_width right_justify colorize
تراز کردن رشته نمایانگر
.Ar value
به سمت راست یا چپ. عرض فیلد در خط اول با
.Ar first_width
تعیین می‌شود. برای خطوط بعدی عرض با
.Ar latter_width
مشخص می‌گردد. اگر
.Ar latter_width
برابر با 1- باشد،
.Ar first_width
برای تمام خطوط استفاده می‌شود. اگر
.Ar right_justify
درست باشد، فیلد درون عرض مشخص‌شده راست‌چین می‌شود. اگر نادرست باشد، فیلد چپ‌چین شده و تا عرض کامل فیلد با فاصله پر می‌گردد. اگر
.Ar colorize
درست باشد، ledger تنظیمات رنگ را اعمال خواهد کرد.
.It Fn market value datetime
بازگرداندن قیمت
.Ar value
در زمان
.Ar datetime .
توجه داشته باشید که
.Ar datetime
باید درون براکت‌ها قرار گیرد تا به درستی تجزیه شود، مانند
.Bq 2012/03/23 .
.It Fn meta name
بازگرداندن مقدار فراداده با نام
.Ar name .
.It Sy note
بازگرداندن یادداشت مربوط به ثبت.
.It Sy now
بازگرداندن تاریخ و زمان جاری.
.\".It Sy null
.It Sy options
متغیری که امکان دسترسی به مقادیر گزینه‌های خط فرمان ارائه‌شده با استفاده از نام‌های بلند گزینه‌ها را فراهم می‌کند، برای مثال برای بررسی اینکه آیا گزینه
.Fl \-daily Pq Fl D
ارائه شده بود یا خیر از
.Sy option.daily
استفاده کنید.
.\" .It Sy partial_account
.It Sy payee
بازگرداندن طرف حساب ثبت.
.It Fn percent value_a value_b
بازگرداندن درصد
.Ar value_a
نسبت به
.Ar value_b
(که به عنوان ۱۰۰٪ در نظر گرفته می‌شود).
.It Sy pending
بازگرداندن درست در صورتی که ثبت به عنوان در انتظار (pending) علامت‌گذاری شده باشد؛ و نادرست در غیر این صورت.
.It Fn percent value_a value_b
بازگرداندن درصد
.Ar value_a
نسبت به
.Ar value_b .
.\".It Sy post
.\" A variable scope
.It Fn print value
چاپ
.Ar value
در خروجی استاندارد (stdout).
استفاده داخلی برای اشکال‌زدایی.
.It Fn quantity value
بازگرداندن مقدار کمیت
.Ar value
برای مقادیری که بهای تمام‌شده به ازای هر واحد دارند.
.It Fn quoted expression
احاطه کردن
.Ar expression
با علامت نقل‌قول دوتایی (گیومه).
.It Fn quoted_rfc expression
احاطه کردن
.Ar expression
با علامت نقل‌قول دوتایی، سازگار با استاندارد RFC 4180.
.It Sy real
.\" Is there a difference between real and actual?
بازگرداندن درست در صورتی که تراکنش واقعی باشد، یعنی یک تراکنش خودکار یا مجازی نباشد؛ و نادرست در غیر این صورت.
.\".It Sy rounded
.It Fn roundto value n
بازگرداندن
.Ar value
گردشده به تعداد
.Ar n
رقم. بر قالب‌بندی اثر نمی‌گذارد.
.It Sy should_bold
بازگرداندن درست در صورتی که عبارت داده‌شده به
.Fl \-bold-if
به درست ارزیابی شود. تنها استفاده داخلی!
.It Fn scrub value
پاکسازی
.Ar value
با استفاده از تبدیل‌های گوناگون مانند گرد کردن، حذف حاشیه‌نویسی‌های مقدار و موارد دیگر.
.\".It Sy status
.It Fn strip value
حذف حاشیه‌نویسی مقدار از
.Ar value .
.\".It Sy subcount
.It Fn tag name
بازگرداندن مقدار برچسب با نام
.Ar name .
.It Fn to_amount value
تبدیل
.Ar value
به یک مبلغ. تنها استفاده داخلی!
.It Fn to_balance value
تبدیل
.Ar value
به یک تراز. تنها استفاده داخلی!
.It Fn to_boolean value
تبدیل
.Ar value
به یک مقدار بولی. تنها استفاده داخلی!
.It Fn to_date value
تبدیل
.Ar value
به یک تاریخ. تنها استفاده داخلی!
.It Fn to_datetime value
تبدیل
.Ar value
به یک تاریخ و زمان. تنها استفاده داخلی!
.It Fn to_int value
بازگرداندن مقدار عدد صحیح برای
.Ar value .
.It Fn to_mask value
تبدیل
.Ar value
به یک ماسک. تنها استفاده داخلی!
.It Fn to_sequence value
تبدیل
.Ar value
به یک دنباله. تنها استفاده داخلی!
.It Fn to_string value
تبدیل
.Ar value
به یک رشته کاراکتری.
.It Sy today
بازگرداندن تاریخ امروز.
.It Sy total
بازگرداندن مجموع ثبت.
.It Sy total_expr
بازگرداندن مجموع محاسبه‌شده ثبت با توجه به گزینه
.Fl \-total .
.It Fn trim value
حذف فاصله‌های سفید ابتدایی و انتهایی از
.Ar value .
.It Fn truncated string total_len account_len
کوتاه کردن
.Ar string
به طول
.Ar total_len
با تضمین اینکه طول هر حساب حداقل به اندازه
.Ar account_len
باشد.
.\".It Sy uncleared
.It Sy virtual
بازگرداندن درست در صورتی که تراکنش مجازی باشد (برای مثال خودکار)؛ و نادرست در غیر این صورت.
.\".It Sy xact
.\" A variable scope
.It Fn averaged_lots
بازگرداندن لات‌ها با میانگین قیمت‌ها.
.It Fn clear_commodity
پاک کردن اطلاعات قیمت‌گذاری کالا/ارز.
.It Fn commodity_price commodity
بازگرداندن قیمت کالا/ارز داده‌شده.
.It Fn display_amount amount
قالب‌بندی مبلغ برای نمایش.
.It Fn display_total total
قالب‌بندی مجموع برای نمایش.
.It Fn lot_date posting
بازگرداندن تاریخ لات یک ثبت.
.It Fn lot_price posting
بازگرداندن قیمت لات یک ثبت.
.It Fn lot_tag posting
بازگرداندن برچسب لات یک ثبت.
.It Fn nail_down amount
تثبیت دقت یک مبلغ.
.It Fn round amount
گرد کردن یک مبلغ به دقت استاندارد.
.It Fn rounded amount
بازگرداندن نسخه گردشده یک مبلغ.
.It Fn set_commodity_price commodity price
تنظیم قیمت برای یک کالا/ارز.
.It Fn top_amount amount
بازگرداندن مبلغ سطح بالا.
.It Fn unround amount
حذف گرد کردن از یک مبلغ.
.It Fn unrounded amount
بازگرداندن نسخه گردنشده یک مبلغ.
.El
.\".Sh ENTRIES
.\".Sh FORMATS
.Sh "دستورات اشکال‌زدایی (DEBUG COMMANDS)"
علاوه بر دستورات گزارش‌گیری معمول،
.Nm
چندین دستور اشکال‌زدایی را نیز می‌پذیرد:
.Bl -tag -width balance
.It Ic args Oo Ar report-query Oc
نمایش تحلیل کاملی از نحوه تفسیر
.Ar report-query
داده‌شده توسط
.Nm .
در صورتی که بخواهید بدانید پرس‌وجوهای گزارش چگونه به عبارات مقداری ترجمه می‌شوند سودمند است.
.It Ic eval Oo Ar value-expression Oc
ارزیابی
.Ar value-expression
داده‌شده و چاپ نتیجه. برای اطلاعات بیشتر درباره عبارات مقداری، بخش
.Sx EXPRESSIONS
را ببینید.
.It Ic format Oo Ar format-string Oc
نمایش تحلیلی از نحوه تجزیه
.Ar format-string
و اینکه اعمال آن روی یک تراکنش نمونه چگونه خواهد بود. برای اطلاعات بیشتر درباره رشته‌های قالب، بخش
.Sx FORMATS
را ببینید.
.It Ic generate
تولید ۵۰ تراکنش تصادفی اما معتبر در
.Nm .
.It Ic parse Oo Ar value-expression Oc
تجزیه
.Ar value-expression
داده‌شده و نمایش تحلیلی از درخت عبارت و مقدار ارزیابی‌شده آن. برای اطلاعات بیشتر درباره عبارات مقداری، بخش
.Sx EXPRESSIONS
را ببینید.
.It Ic python Oo Ar file Oc
فراخوانی یک مفسر پایتون برای خواندن
.Ar file
داده‌شده. نکته ویژه این دستور آن است که ماژول
.Nm
به صورت توکار است و از دیسک خوانده نمی‌شود، بنابراین نیازی به نصب بودن
.Nm
در جایی از سیستم یا ساخت نسخه‌های کتابخانه مشترک آن نیست.
.It Ic reload
بارگذاری مجدد بلادرنگ تمام فایل‌های داده برای نشست جاری.
تنها در
.Tn REPL
قابل استفاده است.
.It Ic template Oo Ar draft-template Oc
نمایش اطلاعاتی درباره نحوه تجزیه
.Ar draft-template .
بخش
.Sx DRAFTS
را ببینید.
.El
.Sh "محیط (ENVIRONMENT)"
هر گزینه‌ای برای
.Nm
در صورتی که دارای نام بلند باشد، می‌تواند با استفاده از یک متغیر محیطی تنظیم شود. برای مثال، تنظیم متغیر محیطی
.Ev LEDGER_DATE_FORMAT="%d.%m.%Y"
اثری مشابه با مشخص کردن
.Fl \-date-format Ar \[aq]%d.%m.%Y\[aq]
در خط فرمان خواهد داشت. با این حال گزینه‌های خط فرمان همیشه نسبت به تنظیمات متغیرهای محیطی اولویت دارند.
.Sh "فایل‌ها (FILES)"
.Bl -tag -width -indent
.It Pa $XDG_CONFIG_HOME/ledger/ledgerrc
.It Pa \[ti]/.config/ledger/ledgerrc
.It Pa \[ti]/.ledgerrc
تنظیمات آغازین شخصی شما برای
.Nm .
.El
.Sh "همچنین ببینید (SEE ALSO)"
.Xr beancount 1 ,
.Xr hledger 1
.Pp
مستندات کامل برای
.Nm
به عنوان یک راهنمای Texinfo نگهداری می‌شود. اگر برنامه
.Nm info
روی سیستم شما نصب شده است، دستور
.Dl info ledger3
باید دسترسی به راهنمای کامل را در اختیارتان بگذارد.
.Sh "نویسندگان (AUTHORS)"
.An "John Wiegley"
.Aq johnw@newartisans.com
.\" .Sh BUGS              \" Document known, unremedied bugs
.\" .Sh HISTORY           \" Document history if command behaves in a unique manner