aboutsummarylogtreecommitdiffstats
path: root/tick.1
diff options
context:
space:
mode:
authorAntony Kellermann2018-02-09 12:23:03 -0500
committerAntony Kellermann2018-02-09 12:23:03 -0500
commit533381686ca8600b12af8c4e57608b42595abbc6 (patch)
treeaa4aa1ad0ad91bdc561ff1fcb8d93b6ecb2b9bfe /tick.1
parent4ab1d13ceb04fdb4a1af04ffa654d8031f32a9aa (diff)
downloadaur-533381686ca8600b12af8c4e57608b42595abbc6.tar.gz
Convert bug fix and added better portfolio output
Diffstat (limited to 'tick.1')
-rw-r--r--tick.131
1 files changed, 29 insertions, 2 deletions
diff --git a/tick.1 b/tick.1
index ff517f678448..a1fa83171a7d 100644
--- a/tick.1
+++ b/tick.1
@@ -13,7 +13,7 @@ Create your portfolio by adding your current holdings. Then, use the option "che
Portfolio:
.TP
-[add/rm/set] [symbol/crypto_id/USD$] [quantity of shares] [USD spent]
+[add/rm/set] [symbol/crypto_id/USD$] [quantity of shares] [USD spent/SharePriceEA]
Either adds, removes, or sets the amount of the given stock with respect to the given values. The parameter "add" will add
your input to the current portfolio, "rm" will subtract from your current portfolio, and "set" will set your portfolio to
the input, discarding any existing data about that security. Trading fees should be factored into "USD SPENT". As an exception,
@@ -22,11 +22,13 @@ US stock market and the cryptocurrency market. You may also input as "usd$" for
track of how much money is unallocated in your brokerage account. Typically, your initial amount of USD can be added as
"tick add USD$ [amount] [amount]", where [amount] is the same number. When you are paid dividends or capital gains that
are not reinvested into a specific security, you should update your portfolio with "tick add USD$ [dividend/capital gain amount] 0".
+You may also specify the share price instead of the total amount you spent by appending "ea" to the end of the share price.
.TP
[check] [currency name/crypto_id/all]
Prints information about your current portfolio holdings. Either a symbol or the keyword 'all' can be used. The keyword "all"
-will print information about all your current holdings, as well as a grand total.
+will print information about all your current holdings, as well as a grand total. Running only 'tick check' will do the same
+thing as 'tick check all'.
.TP
[convert]
@@ -43,6 +45,31 @@ will be displayed. If you would like to use a space in your search, you must eit
your phrase in double quotes. Technically, the input may be something completely unrelated to investing. This may be amended
in the future.
+.SH EXAMPLES
+To add 3 shares of Tesla bought for $918.12 total, run
+.RS
+$ tick add tsla 3 918.12
+
+.RE
+You can also specify the price per share instead of total spent:
+.RS
+$ tick add tsla 3 306.04ea
+
+.RE
+To get info about your current holdings in a Tesla, run
+.RS
+$ tick check tsla
+
+.RE
+Or to get info about all your holdings, run
+.RS
+$ tick check all
+
+.RE
+To get the top three news articles on Tesla in the past two weeks, run
+.RS
+$ tick news tesla
+
.SH FILES
.I ~/.tick_portfolio.json
.RS