aboutsummaryrefslogtreecommitdiff
path: root/cli
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2017-03-05 00:23:23 +0100
committerGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2017-03-05 00:23:23 +0100
commitf6148e1f32548f98401de3676e07d3be5e7c5331 (patch)
tree32b1407c5527164392cbef2caee416c651fdc44e /cli
parent7e251a195e87d64802c64d40627d52d326f63d5f (diff)
CLI user-info readme
https://github.com/FreshRSS/FreshRSS/issues/1449#issuecomment-284191560 https://github.com/FreshRSS/FreshRSS/issues/1447
Diffstat (limited to 'cli')
-rw-r--r--cli/README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/cli/README.md b/cli/README.md
index 5434d1964..0123e8d6e 100644
--- a/cli/README.md
+++ b/cli/README.md
@@ -63,15 +63,15 @@ cd /usr/share/FreshRSS
./cli/user-info.php -h --user username
# -h is to use a human-readable format
# --user can be a username, or '*' to loop on all users
-# Returns a * if the user is admin, the name of the user, the date/time of last action, the size occupied,
-# and the number of: feeds, read articles, unread articles, and favourites
+# Returns: 1) a * iff the user is admin, 2) the name of the user,
+# 3) the date/time of last user action, 4) the size occupied,
+# and the number of: 5) categories, 6) feeds, 7) read articles, 8) unread articles, and 9) favourites
```
## Unix piping
It is possible to invoke a command multiple times, e.g. with different usernames, thanks to the `xargs -n1` command.
-
Example showing user information for all users which username starts with 'a':
```sh
@@ -83,3 +83,9 @@ Example showing all users ranked by date of last activity:
```sh
./cli/user-info.php -h --user '*' | sort -k2 -r
```
+
+Example to get the number of feeds of a given user:
+
+```sh
+./cli/user-info.php --user alex | cut -f6
+```