commit f733ac93794560d2196c45db3f3c1c8aa1bd825d
parent e9ab9324eee6db93b6eb99933b8c08fe12a571b9
Author: Claudio Alessi <smoppy@gmail.com>
Date: Fri, 16 Aug 2024 00:13:05 +0200
Extend and improve the man page.
Diffstat:
| M | sw.1 | | | 36 | ++++++++++++++++++++++++++++-------- |
1 file changed, 28 insertions(+), 8 deletions(-)
diff --git a/sw.1 b/sw.1
@@ -6,8 +6,23 @@ sw \- simple wallet
.RB [ \-v ]\ [ \-defiltx \ <arg>]\ [<date\ [time]\>\ <amount>\ <note>]
.SH DESCRIPTION
sw is a wallet management tool which features a simple yet powerful interface
-to keep track of your money movements. By default (e.g. if no -l is specified)
-last 25 movements are shown.
+to keep track of your money movements. By default (if no -l, -f or -t is
+specified) last 25 movements are shown.
+
+To add a movement run sw with the following arguments:
+.TP
+.B date time
+a string for the date in the format dd/mm/yyyy optionally followed by a time
+(hh:mm). If no time is specified 00:00 is assumed. The word "now" can be used
+to in place of the current date and time.
+.TP
+.B amount
+floating point value which can be positive (incomes) or negative (expenses)
+.TP
+.B note
+An arbitrary string which identify the movement
+.TP
+Example: sw "14/08/2024 14:52" -90.52 "Food and drink for Ferragosto"
.SH OPTIONS
.TP
.B \-v
@@ -17,11 +32,13 @@ prints version information to standard output, then exits.
remove the specified movement, then exits.
.TP
.B \-e\ <text>
-consider only movements that include the given string (case insensitive). May
-be specified multiple times.
+show only movements that match the given string (case insensitive). May be
+specified multiple times.
.TP
.B \-f\ <date\ [time]>
-consider only movements after the given date and optional time
+show only movements corresponding to or subsequent to the given date (and
+optional time) string. See DESCRIPTION for informations on date and time
+formats.
.TP
.B \-i\ <file>
use the given file as movements database.
@@ -31,8 +48,11 @@ limit the number of movements in the listing. If zero is specified then assume
a value of INT_MAX (show all movements).
.TP
.B \-t\ <date\ [time]>
-consider only movements before the given date and optional time
+show only movements corresponding to or prior to the given date (and optional
+time) string. See DESCRIPTION for informations on date and time formats.
.TP
.B \-x\ <text>
-exclude all movements that include the given string (case insensitive). May
-be specified multiple times.
+exclude all movements that include the given string (case insensitive). May be
+specified multiple times.
+.SH NOTES
+Custom formats for dates will be supported in future version of sw.
