-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Also attempt to install them in setup.py and mention them in the README. No manual page for updateprices since it seems to no longer work.
- Loading branch information
Showing
7 changed files
with
343 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
.\" Hey, EMACS: -*- nroff -*- | ||
.\" (C) Copyright 2022 Marcin Owsiany <[email protected]>, | ||
.\" | ||
.\" First parameter, NAME, should be all caps | ||
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection | ||
.\" other parameters are allowed: see man(7), man(1) | ||
.TH addtrans 1 "November 11 2022" | ||
.\" Please adjust this date whenever revising the manpage. | ||
.\" | ||
.\" Some roff macros, for reference: | ||
.\" .nh disable hyphenation | ||
.\" .hy enable hyphenation | ||
.\" .ad l left justify | ||
.\" .ad b justify to both left and right margins | ||
.\" .nf disable filling | ||
.\" .fi enable filling | ||
.\" .br insert line break | ||
.\" .sp <n> insert n+1 empty lines | ||
.\" for manpage-specific macros, see man(7) | ||
.SH NAME | ||
addtrans \- interactively add transactions to a ledger file | ||
.SH SYNOPSIS | ||
.B addtrans | ||
.RI [ options ] | ||
.SH DESCRIPTION | ||
.B addtrans | ||
is a graphical application for quickly adding new transactions to a ledger file. | ||
.PP | ||
A tutorial for using this program, with screenshots, is available at | ||
.BR /usr/share/doc/ledgerhelpers/doc/addtrans.html | ||
.PP | ||
The program must be supplied with locations of the ledger and price database | ||
files to work with. | ||
The location of each file is determined independently, using the following | ||
mechanisms, in this order. | ||
The first mechanism which yields a result, wins. | ||
.SH OPTIONS | ||
.TP | ||
.BR \-h , | ||
.BR \-\-help | ||
Show help message and exit. | ||
.TP | ||
.B \-\-file FILE | ||
Specify path to ledger file to work with. | ||
.TP | ||
.B \-\-price\-db PRICEDB | ||
Specify path to ledger price database to work with. | ||
.TP | ||
.B \-\-debug | ||
Turn on debugging output, may be useful for developers. | ||
.SH ENVIRONMENT | ||
The following environment variables are recognized by this program: | ||
.TP | ||
.BR LEDGER_FILE | ||
Path to ledger file to work with. | ||
.TP | ||
.BR LEDGER_PRICE_DB | ||
Path to ledger price database to work with. | ||
.SH FILES | ||
The config file for | ||
.BR ledger (1), | ||
namely file | ||
.BR .ledgerrc | ||
in user's home directory is scanned looking for the following options. | ||
.TP | ||
.B \-\-file FILE | ||
Path to ledger file to work with. | ||
.TP | ||
.B \-\-price\-db PRICEDB | ||
Path to ledger price database to work with. | ||
|
||
.SH SEE ALSO | ||
.BR ledger (1), | ||
.BR cleartrans\-cli (1), | ||
.BR sellstock\-cli (1), | ||
.BR sorttrans\-cli (1), | ||
.BR withdraw\-cli (1). | ||
.br | ||
A tutorial for using this program, with screenshots, is available at | ||
.BR /usr/share/doc/ledgerhelpers/doc/addtrans.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
.\" Hey, EMACS: -*- nroff -*- | ||
.\" (C) Copyright 2022 Marcin Owsiany <[email protected]>, | ||
.\" | ||
.\" First parameter, NAME, should be all caps | ||
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection | ||
.\" other parameters are allowed: see man(7), man(1) | ||
.TH cleartrans\-cli 1 "November 11 2022" | ||
.\" Please adjust this date whenever revising the manpage. | ||
.\" | ||
.\" Some roff macros, for reference: | ||
.\" .nh disable hyphenation | ||
.\" .hy enable hyphenation | ||
.\" .ad l left justify | ||
.\" .ad b justify to both left and right margins | ||
.\" .nf disable filling | ||
.\" .fi enable filling | ||
.\" .br insert line break | ||
.\" .sp <n> insert n+1 empty lines | ||
.\" for manpage-specific macros, see man(7) | ||
.SH NAME | ||
cleartrans\-cli \- interactively clear transactions in a ledger file | ||
.SH SYNOPSIS | ||
.B cleartrans | ||
.SH DESCRIPTION | ||
.B cleartrans\-cli | ||
is a text program for quickly clearing transactions in a ledger file. | ||
.PP | ||
This program looks for all uncleared transactions in the ledger file, | ||
whose effective date is not in the future. | ||
For each such transaction, it asks whether the transaction should be cleared, | ||
and prompts for an effective date for the transaction. | ||
.PP | ||
The resulting ledger is written to a new file, and atomically renamed to the original | ||
filename. This prevents accidental loss of data. | ||
.PP | ||
The program must be supplied with location of the ledger file to work with. | ||
The location of the file is determined using the following mechanisms, in this | ||
order. | ||
The first mechanism which yields a result, wins. | ||
.SH ENVIRONMENT | ||
The following environment variable is recognized by this program: | ||
.TP | ||
.BR LEDGER_FILE | ||
Path to ledger file to work with. | ||
.SH FILES | ||
The config file for | ||
.BR ledger (1), | ||
namely file | ||
.BR .ledgerrc | ||
in user's home directory is scanned looking for the following option. | ||
.TP | ||
.B \-\-file FILE | ||
Path to ledger file to work with. | ||
.SH SEE ALSO | ||
.BR ledger (1), | ||
.BR addtrans (1), | ||
.BR sellstock\-cli (1), | ||
.BR sorttrans\-cli (1), | ||
.BR withdraw\-cli (1). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
.\" Hey, EMACS: -*- nroff -*- | ||
.\" (C) Copyright 2022 Marcin Owsiany <[email protected]>, | ||
.\" | ||
.\" First parameter, NAME, should be all caps | ||
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection | ||
.\" other parameters are allowed: see man(7), man(1) | ||
.TH sellstock\-cli 1 "November 14 2022" | ||
.\" Please adjust this date whenever revising the manpage. | ||
.\" | ||
.\" Some roff macros, for reference: | ||
.\" .nh disable hyphenation | ||
.\" .hy enable hyphenation | ||
.\" .ad l left justify | ||
.\" .ad b justify to both left and right margins | ||
.\" .nf disable filling | ||
.\" .fi enable filling | ||
.\" .br insert line break | ||
.\" .sp <n> insert n+1 empty lines | ||
.\" for manpage-specific macros, see man(7) | ||
.SH NAME | ||
sellstock\-cli \- record FIFO stock or commodity sales | ||
.SH SYNOPSIS | ||
.B sellstock\-cli | ||
.SH DESCRIPTION | ||
.B sellstock\-cli | ||
is a text program for quickly recording commodity sales in a ledger file. | ||
.PP | ||
The program first prompts for the account in which the commodity was stored, | ||
the account for commissions, and the account to credit for gains and losses, | ||
as well as the amount and name of sold commodity, its sale price, and the | ||
commission. | ||
.PP | ||
Then the program invokes | ||
.B ledger | ||
to list the dates and prices at which each commodity was purchased, lists them, | ||
subtracts the requested amount and shows the result. | ||
.PP | ||
Finally, the resulting transaction is shown, asking for a confirmation to save | ||
it to the journal. | ||
.PP | ||
The program must be supplied with location of the ledger file to work with. | ||
The location of the file is determined using the following mechanisms, in this | ||
order. | ||
The first mechanism which yields a result, wins. | ||
.SH ENVIRONMENT | ||
The following environment variable is recognized by this program: | ||
.TP | ||
.BR LEDGER_FILE | ||
Path to ledger file to work with. | ||
.SH FILES | ||
The config file for | ||
.BR ledger (1), | ||
namely file | ||
.B .ledgerrc | ||
in user's home directory is scanned looking for the following option. | ||
.TP | ||
.B \-\-file FILE | ||
Path to ledger file to work with. | ||
|
||
.SH SEE ALSO | ||
.BR ledger (1), | ||
.BR addtrans (1), | ||
.BR cleartrans\-cli (1), | ||
.BR sorttrans\-cli (1), | ||
.BR withdraw\-cli (1). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
.\" Hey, EMACS: -*- nroff -*- | ||
.\" (C) Copyright 2022 Marcin Owsiany <[email protected]>, | ||
.\" | ||
.\" First parameter, NAME, should be all caps | ||
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection | ||
.\" other parameters are allowed: see man(7), man(1) | ||
.TH sorttrans\-cli 1 "November 14 2022" | ||
.\" Please adjust this date whenever revising the manpage. | ||
.\" | ||
.\" Some roff macros, for reference: | ||
.\" .nh disable hyphenation | ||
.\" .hy enable hyphenation | ||
.\" .ad l left justify | ||
.\" .ad b justify to both left and right margins | ||
.\" .nf disable filling | ||
.\" .fi enable filling | ||
.\" .br insert line break | ||
.\" .sp <n> insert n+1 empty lines | ||
.\" for manpage-specific macros, see man(7) | ||
.SH NAME | ||
sorttrans\-cli \- sorts a ledger file in chronological order | ||
.SH SYNOPSIS | ||
.B sorttrans\-cli | ||
.RI [ options ] | ||
.SH OPTIONS | ||
.TP | ||
.BR -y | ||
Write back the file immediately, without showing the differences. | ||
.TP | ||
.BR \-h , | ||
.BR \-\-help | ||
Show help message and exit. | ||
.TP | ||
.B \-\-file FILE | ||
Specify path to ledger file to work with. | ||
.TP | ||
.B \-\-price\-db PRICEDB | ||
Specify path to ledger price database to work with. | ||
.TP | ||
.B \-\-debug | ||
Turn on debugging output, may be useful for developers. | ||
. | ||
.SH DESCRIPTION | ||
.B sorttrans\-cli | ||
is a text program for sorting a ledger in chronological order. | ||
.PP | ||
The program loads the ledger file and sorts the transactions in memory. | ||
Then, depending on the command-line options, it either writes the sorted file | ||
back, or invokes | ||
.B meld | ||
with the original and sorted version shown, for interactive editing. | ||
.PP | ||
The program must be supplied with location of the ledger file to work with. | ||
If not supplied using the command-line option | ||
.BR \-\-file , | ||
the location of the file is determined using the following mechanisms, in this | ||
order. | ||
The first mechanism which yields a result, wins. | ||
.SH ENVIRONMENT | ||
The following environment variable is recognized by this program: | ||
.TP | ||
.BR LEDGER_FILE | ||
Path to ledger file to work with. | ||
.SH FILES | ||
The config file for | ||
.BR ledger (1), | ||
namely file | ||
.B .ledgerrc | ||
in user's home directory is scanned looking for the following option. | ||
.TP | ||
.B \-\-file FILE | ||
Path to ledger file to work with. | ||
|
||
.SH SEE ALSO | ||
.BR ledger (1), | ||
.BR meld (1), | ||
.BR addtrans (1), | ||
.BR cleartrans\-cli (1), | ||
.BR sellstock\-cli (1), | ||
.BR withdraw\-cli (1). | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
.\" Hey, EMACS: -*- nroff -*- | ||
.\" (C) Copyright 2022 Marcin Owsiany <[email protected]>, | ||
.\" | ||
.\" First parameter, NAME, should be all caps | ||
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection | ||
.\" other parameters are allowed: see man(7), man(1) | ||
.TH withdraw\-cli 1 "November 11 2022" | ||
.\" Please adjust this date whenever revising the manpage. | ||
.\" | ||
.\" Some roff macros, for reference: | ||
.\" .nh disable hyphenation | ||
.\" .hy enable hyphenation | ||
.\" .ad l left justify | ||
.\" .ad b justify to both left and right margins | ||
.\" .nf disable filling | ||
.\" .fi enable filling | ||
.\" .br insert line break | ||
.\" .sp <n> insert n+1 empty lines | ||
.\" for manpage-specific macros, see man(7) | ||
.SH NAME | ||
withdraw\-cli \- record multi-currency ATM withdrawals in a ledger file | ||
.SH SYNOPSIS | ||
.B withdraw | ||
.SH DESCRIPTION | ||
.B withdraw\-cli | ||
is a text program for quickly entering cash withdrawal transactions in a | ||
ledger file. | ||
.PP | ||
This program interactively asks for accounts and withdrawn and deposited | ||
amounts, and adds a transaction to the ledger file after confirmation. | ||
.PP | ||
The program must be supplied with location of the ledger file to work with. | ||
The location of the file is determined using the following mechanisms, in this | ||
order. | ||
The first mechanism which yields a result, wins. | ||
.SH ENVIRONMENT | ||
The following environment variable is recognized by this program: | ||
.TP | ||
.BR LEDGER_FILE | ||
Path to ledger file to work with. | ||
.SH FILES | ||
The config file for | ||
.BR ledger (1), | ||
namely file | ||
.BR .ledgerrc | ||
in user's home directory is scanned looking for the following option. | ||
.TP | ||
.B \-\-file FILE | ||
Path to ledger file to work with. | ||
.SH SEE ALSO | ||
.BR ledger (1), | ||
.BR addtrans (1), | ||
.BR cleartrans\-cli (1), | ||
.BR sellstock\-cli (1), | ||
.BR sorttrans\-cli (1). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters