/usr/share/doc/clipf/README is in clipf 0.5-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 | Contacts:
Developer: Galtsev Denis <galtsevdv@gmail.com>
Project site: http://code.google.com/p/clipf/
Installation:
Not required. It is simple python script. Put it to any directory in Your PATH
Configuration:
Not required. Program would create config directory and empty database
at start, if config directory doesn't exists (default to "~/.clipf/").
Usage description:
clipf [<config_path>]
- start clipf with coniguration in <config_path> (default to
~/.clipf). If config_path doesn't exists, it would be created
with appropriate defaults.
All commands described in embedded help. Type "help" in command line
to see list of available commands, and "help <command>" for help
about particular command.
Before further use, You need to enter some income/expense categories:
>prod add [-d] <prod_code> <prod_name>
-d options mark this category as debt (income). Category is credit (expense) by default.
Examples:
# enter category codes with trailing period
>prod add meal. Meals
# p shortcuts to prod
>p add meal.drink. Drinks
# Enter category names with spaces in quotes
>p add meal.drink.beer "My preferred beer"
>p add meal.juice Juice
>p add meal.cookie Cookie
>p add meal.nuts "Roasted nuts"
# You need identify category as income during creation
>p add -d salary Salary
Now You can see Your category list:
>prod ls [<prod_group>]
- show _one_ level of category tree (default to root).
Example:
>prod ls
>prod ls meal.
Remove products with:
>prod rm <prod_code>
Now You can enter some operations:
>op add [-a <account>] [-d <date>] <prod_code> <amount> [<note>]
* -a <account> - override default account for this operation.
* -d <date> - override default date for this operation. Enter date in "YYYY-MM-DD" format.
Examples
# Entering starting remain as salary
>op add salary 450.0 "Starting remain"
# now some expenses:
>op add meal.drink.beer 5.5
>op add meal.nuts 3.45 "Nuts to beer"
>op add meal.cookie 2.80
Use tab completion to enter long prod codes (press <tab> once or twice during prod_code entering).
List entered operations with:
>op ls [<prod_code_pattern>]
- show list of operations in selected period (see {{{set}}})
* <prod_code_pattern> - show operations with prod_code starting with prod_code_pattern
Delete operation: impossible. You need to enter the same operation with negative amount to revoke already entered operation.
Now let's list and change some defaults:
# see list of options
>show
#set option value
>set <option_name> <option_value>
options description:
* *date* - default date for new operations
* *acc* - default account for new operations
* *date_from, date_to* - period for all listings ({{{op ls}}} and reports
* *max_lines* - if show operation output in pager (less) if output length is more, than <max_lines> lines.
Reports
>rep prod [<prod_group>]
>rep acc
Example:
# set period for reports
>set date_from 2008-03-01
>set date_to 2008_03-31
# show totals by top level groups
>rep prod
# show details for meal. group
>rep prod meal.
# turnover by accounts
>rep acc
Other useful features:
Program understand input stream redirection:
$echo -e "set date_from 2008-04-01\nop ls" | clipf
- this can be used to save reports.
You can setup aliases (shortcuts) for frequently used operations in config file (default to ~/.clipf/clipf.conf).
See configuration file for examples.
|