diff options
| author | Yaroslav de la Peña Smirnov <yps@yaroslavps.com> | 2020-12-08 01:46:12 +0300 |
|---|---|---|
| committer | Yaroslav de la Peña Smirnov <yps@yaroslavps.com> | 2020-12-08 01:46:12 +0300 |
| commit | c9b64850eba97a08068ce6914a0d2fe50af49aa8 (patch) | |
| tree | d2bdbd20000cbfe917e80e4b0737b9ec0e2296ac /docs | |
| parent | cc00db276c203bdcff9ca32d857d23e5dc61f400 (diff) | |
| download | finbudg-master.tar.gz finbudg-master.zip | |
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/finbudg.1.scd | 6 | ||||
| -rw-r--r-- | docs/finbudg.5.scd | 19 |
2 files changed, 16 insertions, 9 deletions
diff --git a/docs/finbudg.1.scd b/docs/finbudg.1.scd index 8e3f7e3..e054c9b 100644 --- a/docs/finbudg.1.scd +++ b/docs/finbudg.1.scd @@ -17,9 +17,13 @@ a file containing a list of expenses made for a specified period of time. See # FLAGS -*-h, --help * +*-h, --help* Prints the list of flags available. +*-w, --consider-owed* + Take into account what's owed when calculating the total + and subtotals. + *-p, --plain* Don't colorize the output. Can also be set with the *NO_COLOR* environment variable. diff --git a/docs/finbudg.5.scd b/docs/finbudg.5.scd index 72bfd58..ae485c1 100644 --- a/docs/finbudg.5.scd +++ b/docs/finbudg.5.scd @@ -56,14 +56,17 @@ The expenses file should contain at the start the following keys: *category*=String The category to which this expense belongs. _Optional_. - *shared*=uint32 - If more than one, then the amount of people this expense was - shared with. _Optional_. - - *recurring*=bool - Indicates if this is a recurring expense, i.e. one that - repeats for each period of time. For example, electricity - bills. _Optional_. + *shared*=array<String> + An list of names of the people that this expense is shared + with proportionally. If owed equals true, then you are not + part of this expense, and the people listed here owe you all + of this expense. _Optional_. + + *owed*=boolean + A boolean value that indicates whether you paid for this for + another person or persons. If set to true, then shared + should contain at least one name. _Optional_. + # NOTES |