ayadn 1.8.2 → 2.0

data/doc/05-streams.md

@@ -8,7 +8,6 @@ This is also called the 'Unified stream': it regroups the posts of people you fo
 
 `ayadn -tl`
 
-
 ## AVAILABLE OPTIONS
 
 ### SCROLL
@@ -17,11 +16,11 @@ Scroll your timeline with:
 
 `ayadn timeline --scroll`
 
-`ayadn -tl -s`
+`ayadn -tl -s`  
 
 #### SCROLL REFRESH
 
-*Read this if you want to launch several scroll streams at once*
+*Read this only if you want to launch several scroll streams at once*
 
 Ayadn pulls the stream every 3 seconds by default. It means you can launch up to 3 scroll streams at a time _per account_ if you want. 
 
@@ -63,7 +62,11 @@ Example:
 
 `ayadn -R 33`
 
-if 33 is the number of the indexed post you want to reply to.  
+if 33 is the number of the indexed post you want to reply to. 
+
+Note: since Ayadn 2.0, posts index resolution is activated by default for posts ids from 1 to 200. Add option `--force` to ignore index and retrieve the actual old post if needed.
+
+This absolute range from 1 to 200 for indexed posts exists because indexed posts aren't available in scroll views, so an index will never be greater than 200 (which is the ADN number of posts per request limit).
 
 ### NEW
 
@@ -117,13 +120,30 @@ Differences will occur due to ADN policy:
 
 Removes the line-breaks when possible, and forces the view to be "compact".
 
-Set it with:
+Option is `-k` (or `--compact`):
+
+`ayadn global --scroll --compact`
+
+`ayadn timeline --index --count=200 --compact`
+
+`ayadn userposts me --name --compact`
+
+or
+
+`ayadn -gl -s -k`
+
+`ayadn -tl -i -c200 -k`
+
+`ayadn -up me -n -k`
+
+*Works with all compatible views, streams and lists.*
+
+Set it permanently with:
 
 `ayadn set timeline compact true`
 
 You may want to change colors to create visual marks between posts if you choose the compact view, i.e. putting the all header in the same color (post id, username, name, etc).
 
-
 # GLOBAL
 
 Display the 'Global stream'.
@@ -227,9 +247,9 @@ You can pass an option to avoid this for the time of the command:
 
 Or you can set it off permanently:
 
-`ayadn set marker update_messages false`
+`ayadn set marker messages false`
 
-Since version 1.7.7, Ayadn shows the full oembed links in messages if any. As these links can be quite long and complex, you can remove them from the view if you want with `ayadn set timeline show_channel_oembed false`.  
+Since version 1.7.7, Ayadn shows the full oembed links in messages if any. As these links can be quite long and complex, you can remove them from the view if you want with `ayadn set channels links false`.  
 
 # UNREAD MESSAGES
 
@@ -247,7 +267,7 @@ You can pass an option to avoid this for the time of the command:
 
 Or you can set it off permanently:
 
-`ayadn set marker update_messages false`  
+`ayadn set marker messages false`  
 
 # WHATSTARRED
 

data/doc/06-post.md

@@ -14,7 +14,7 @@ You have to put your text between single quotes if you're using punctuation:
 
 *But remember you can't use any quote character inside the quotes...*
 
-**So you should rather use either the _write_ or the _auto_ method for posting.**
+**So you should rather use the _write_ method for posting.**
 
 # WRITE
 
@@ -40,8 +40,6 @@ Just type a @username at the beginning of your post if you want to mention a spe
 
 Auto post every line of input.
 
-The is the funniest way to post to ADN! :)  
-
 `ayadn auto`
 
 In this mode, each line you type (each time you hit ENTER!) is automatically posted to ADN.
@@ -52,6 +50,8 @@ Hit CTRL+C to exit this mode at any moment.
 
 # REPLY
 
+## CLASSIC
+
 Reply to a specific post.
 
 - You can reply by specifying the post id:
@@ -64,10 +64,16 @@ Ayadn will then show you the *write* prompt.
 
 If you reply to a post containing multiple mentions, your text will be inserted between the leading mention and the other ones.
 
+## INDEXED
+
 - You can also reply to the *index* of the post instead of its *id* _if you used the '--index' or '-i' option_ when previously viewing a stream:
 
 `ayadn -R 3`  
 
+Note: since Ayadn 2.0, posts index resolution is activated by default for posts ids from 1 to 200. Add option `--force` to ignore index and retrieve the actual old post if needed.
+
+## REDIRECT
+
 If you reply to a reposted post, Ayadn will reply to the original post, complying with the ADN guidelines.
 
 However, if needed, you can reply to the reposted post with the `--noredirect` option:
@@ -76,6 +82,8 @@ However, if needed, you can reply to the reposted post with the `--noredirect` o
 
 `ayadn -R -n 23344556`  
 
+*Note: these two last concepts, "indexed" and "redirect" are also activated by default for all posts commands (repost, star, delete, etc).*
+
 
 # PM (PRIVATE MESSAGE)
 
@@ -93,7 +101,7 @@ You can pass an option to avoid this for the time of the command:
 
 Or even invert this behaviour permanently with `set`:
 
-`ayadn set marker update_messages false`  
+`ayadn set marker messages false`  
 
 # SEND
 
@@ -113,7 +121,7 @@ You can pass an option to avoid this for the time of the command:
 
 Or even invert this behaviour permanently with `set`:
 
-`ayadn set marker update_messages false`  
+`ayadn set marker messages false`  
 
 If you've already created an [alias](#alias) for the channel, you can post to it with:
 

data/doc/07-actions.md

@@ -6,6 +6,24 @@ Delete a post.
 
 `ayadn -D 23365251`
 
+Accepts several post ids:
+
+`ayadn -D 23365251 23365252 23365253`  
+
+*Also works with indexed posts (as do all posts commands like repost, star, etc since version 2.0).*
+
+Example:
+
+`ayadn -up -i me`
+
+then
+
+`ayadn -D 03 12 42`
+
+Since Ayadn 2.0, posts index resolution is activated by default for posts ids from 1 to 200. Add option `--force` to ignore index and retrieve the actual old post if needed.
+
+*Note: this "indexed" concept is also active by default for all posts commands (repost, star, reply, etc).*
+
 # DELETE_M
 
 Delete a private message. 
@@ -18,6 +36,10 @@ You have to specify channel id (or alias) then message number.
 
 `ayadn -DM my_alias 3365251`
 
+Accepts several message ids:
+
+`ayadn -DM my_alias 23365251 23365252 23365253`  
+
 # REPOST
 
 Repost a post.
@@ -26,6 +48,10 @@ Repost a post.
 
 `ayadn -O 23365251`
 
+Accepts several post ids:
+
+`ayadn -O 23365251 23365252 23365253`
+
 # UNREPOST
 
 Unrepost a post.
@@ -34,6 +60,10 @@ Unrepost a post.
 
 `ayadn -UR 23365251`
 
+Accepts several post ids:
+
+`ayadn -UR 23365251 23365252 23365253`
+
 # STAR
 
 Star a post.
@@ -42,6 +72,10 @@ Star a post.
 
 `ayadn -ST 23365251`
 
+Accepts several post ids:
+
+`ayadn -ST 23365251 23365252 23365253`
+
 # UNSTAR
 
 Unstar a post.
@@ -50,6 +84,10 @@ Unstar a post.
 
 `ayadn -US 23365251`
 
+Accepts several post ids:
+
+`ayadn -US 23365251 23365252 23365253`
+
 # FOLLOW
 
 Follow a user.
@@ -58,6 +96,10 @@ Follow a user.
 
 `ayadn -FO @ericd`
 
+Accepts several users:
+
+`ayadn -FO @ericd @ayadn @adnapi`
+
 # UNFOLLOW
 
 Unfollow a user.
@@ -66,6 +108,10 @@ Unfollow a user.
 
 `ayadn -UF @ericd`
 
+Accepts several users:
+
+`ayadn -UF @ericd @ayadn @adnapi`
+
 # MUTE
 
 Mute a user.
@@ -74,6 +120,10 @@ Mute a user.
 
 `ayadn -MU @spammer`
 
+Accepts several users:
+
+`ayadn -MU @spammer @thickhead`
+
 # UNMUTE
 
 Unmute a user.
@@ -82,6 +132,10 @@ Unmute a user.
 
 `ayadn -UM @spammer`
 
+Accepts several users:
+
+`ayadn -UM @spammer @thickhead`
+
 # BLOCK
 
 Block a user (same as mute but also prevents the blocked user to follow you).
@@ -90,6 +144,10 @@ Block a user (same as mute but also prevents the blocked user to follow you).
 
 `ayadn -BL @spammer`
 
+Accepts several users:
+
+`ayadn -BL @spammer @thickhead`
+
 # UNBLOCK
 
 Unblock a user.
@@ -98,9 +156,13 @@ Unblock a user.
 
 `ayadn -UB @spammer`
 
+Accepts several users:
+
+`ayadn -UB @spammer @thickhead`
+
 # DOWNLOAD
 
-Download a file from your App.net storage (any file posted with other ADN clients).
+Download a file from your App.net storage (any file posted with any ADN client).
 
 `ayadn download 23344556`
 

data/doc/08-listings.md

@@ -10,6 +10,32 @@ You can see your own list by using *me* instead of *@username*:
 
 `ayadn -fwr me`
 
+Sort the list by username:
+
+`ayadn -fwr -u me`
+
+Sort the list by name:
+
+`ayadn -fwr -n me`
+
+Sort the list by posts/day:
+
+`ayadn -fwr -d me`
+
+Sort the list by total posts:
+
+`ayadn -fwr -p me`
+
+Reverse the list order:
+
+`ayadn -fwr -r me`
+
+`ayadn -fwr -u -r me`
+
+Force compact view (works with all compatible listing views):
+
+`ayadn -fwr -k me`
+
 # FOLLOWINGS
 
 List the users a user is following.
@@ -22,6 +48,28 @@ You can see your own list by using *me* instead of *@username*:
 
 `ayadn -fwg me`
 
+Sort the list by username:
+
+`ayadn -fwg -u me`
+
+Sort the list by name:
+
+`ayadn -fwg -n me`
+
+Sort the list by posts/day:
+
+`ayadn -fwg -d me`
+
+Sort the list by total posts:
+
+`ayadn -fwg -p me`
+
+Reverse the list order:
+
+`ayadn -fwg -r me`
+
+`ayadn -fwg -u -r me`
+
 # CHANNELS
 
 List all your active App.net channels.
@@ -36,11 +84,21 @@ Retrieve a unique channel, or specific channel(s), with option `--id`:
 
 `ayadn -ch --id 55123 34678 988776`
 
-Display raw response with option `-x`:
+Retrieve only your broadcast channel(s):
+
+`ayadn -ch --broadcasts`
+
+Retrieve only your private messages channel(s):
+
+`ayadn -ch --messages`
 
-`ayadn -ch -x`
+Retrieve only your patter room channel(s):
 
-`ayadn -ch -x --id 55123`  
+`ayadn -ch --patter`
+
+Retrieve all channel(s) except broadcasts, messages or patter:
+
+`ayadn -ch --other`  
 
 # INTERACTIONS
 
@@ -66,6 +124,28 @@ List the users you muted.
 
 `ayadn -mtd`
 
+Sort the list by username:
+
+`ayadn -mtd -u`
+
+Sort the list by name:
+
+`ayadn -mtd -n`
+
+Sort the list by posts/day:
+
+`ayadn -mtd -d`
+
+Sort the list by total posts:
+
+`ayadn -mtd -p`
+
+Reverse the list order:
+
+`ayadn -mtd -r`
+
+`ayadn -mtd -u -r`
+
 # BLOCKED
 
 List the users you blocked.
@@ -74,6 +154,28 @@ List the users you blocked.
 
 `ayadn -bkd`
 
+Sort the list by username:
+
+`ayadn -bkd -u`
+
+Sort the list by name:
+
+`ayadn -bkd -n`
+
+Sort the list by posts/day:
+
+`ayadn -bkd -d`
+
+Sort the list by total posts:
+
+`ayadn -bkd -p`
+
+Reverse the list order:
+
+`ayadn -bkd -r`
+
+`ayadn -bkd -u -r`
+
 # SETTINGS
 
 List current Ayadn settings.
@@ -100,7 +202,7 @@ List them all:
 
 ### LIST
 
-You can reverse the default lists order with a `set` command:
+You can permanently reverse the ADN default list order with a `set` command:
 
 `ayadn set formats list reverse false`
 
@@ -113,3 +215,9 @@ You can change the width of the lists table if the default size doesn't fit well
 `ayadn set formats table width 80`
 
 (min: 60, max: 90, default: 75)
+
+And also enable/disable the tables borders:
+
+`ayadn set formats table borders false`
+
+(default: true)

data/doc/09-accounts.md

@@ -4,6 +4,8 @@ Authorize Ayadn for a specific user account.
 
 `ayadn authorize`
 
+or 
+
 `ayadn -auth`
 
 Ayadn will give you a link leading to the official App.net registration page.
@@ -12,22 +14,34 @@ After your successful login, you will be redirected to the Ayadn authorization p
 
 Copy the code (token) you will find there and paste it into Ayadn: a new user will be created and automatically logged in.  
 
+*Note: authorizing an already authorized user updates the old content with the new content: token, name, etc.*
+
 # SWITCH
 
 Switch between your authorized accounts.
 
 `ayadn switch @ericd`
 
-`ayadn switch @mysecretaccount`
+`ayadn switch ericd`
 
 Alternative syntax:
 
 `ayadn -@ ericd`
 
-`ayadn -@ mysecretaccount`
-
 List your authorized accounts:
 
 `ayadn switch -l`
 
 `ayadn -@ -l`
+
+# UNAUTHORIZE
+
+Unauthorize an Ayadn user account.
+
+`ayadn unauthorize @ericd`
+
+`ayadn -UA ericd`
+
+You can specify the `--delete` (`-D`) option to force delete the account folders:
+
+`ayadn -UA -D @ericd`

data/doc/10-nicerank.md

@@ -26,19 +26,19 @@ An idea of the scale:
 
 - A regular user will always be > 2
 
-- Active regular users will be > 3
-
-- Very 'social' users can be > 4
+- Very active and 'social' users will be > 3
 
 *Again, this is not a popularity ratio: far from it. It only serves as a filter for bots and spam.*
 
+In addition to this manual rank filter, NiceRank and Ayadn have other automatic filtering based upon the information publicly available about the users.
+
 ## Threshold
 
 Set the NiceRank threshold.
 
 You can use an integer or a float (only one decimal).
 
-Any user with a NiceRank smaller than this value will be ignored.
+Any user with a NiceRank smaller than this value will be ignored in the Global stream.
 
 `ayadn set nicerank threshold 2.5`
 
@@ -52,4 +52,4 @@ NiceRank is enabled by default on new Ayadn installations, but can be disabled i
 
 `ayadn set nicerank filter false`
 
-`ayadn set nicerank filter_unranked false`
+*Note: the other field, `unranked`, can be activated to ignore the users who haven't been analysed by NiceRank yet. It's more an experimental feature, and it's actually recommended to always let it to false.*

data/doc/11-blacklist.md

@@ -1,10 +1,10 @@
 # BLACKLIST
 
-The blacklist is a list of users, clients and hashtags that you don't want to ever be displayed.
+The blacklist is a list of users, clients and hashtags that you don't want to be displayed anywhere in Ayadn.
 
-Available subcommands: add, remove, import, list.
+Available subcommands: add, remove, list.
 
-This is different from the 'mute a user' feature of the App.net API: blacklist works locally and is specific to each account.
+This is different from the 'mute a user' feature of the App.net API: blacklist works locally and is specific to each Ayadn account.
 
 Blacklist a client (example: IFTTT) and posts that are posted with this client won't appear in the streams.
 
@@ -12,9 +12,11 @@ This is a way of creating "bot-free" streams: the more bots you add to this list
 
 Blacklist a hashtag and you will free yourself from this annoying trend you can't stand.
 
-Blacklist a user and you won't even see posts by other users mentioning the user you blacklisted!
+Blacklist a user and, well, never see this user again.
 
-Oh, and you can import blacklist databases from other accounts, too.
+Blacklist a mention and you won't even see posts by other users mentioning the user you blacklisted!
+
+*Since Ayadn 2.0, adding and removing to/from the blacklist takes immediately effect and is shared with other Ayadn instances launched by the same user.*
 
 ## ADD
 
@@ -70,15 +72,7 @@ List all items in your blacklist.
 
 `ayadn blacklist list`
 
-`ayadn -K list`
-
-## IMPORT
-
-Import a blacklist database in the current account.
-
-`ayadn blacklist import '/Users/blah/backups/blacklist.db'`
-
-`ayadn -K import '/Users/blah/backups/blacklist.db'`
+`ayadn -K list`  
 
 ## MULTIPLE TARGETS
 

data/doc/12-alias.md

@@ -1,6 +1,6 @@
 # ALIAS
 
-Aliases are names you give to channels for an easier access.
+Aliases are names you give to channels to access them more easily in Ayadn.
 
 Available subcommands: create, delete, list, import.
 
@@ -14,10 +14,6 @@ you can create an alias:
 
 `ayadn alias create 46216 pasteapp`
 
-or
-
-`ayadn -A create 46216 pasteapp`
-
 Then you can access this channel with 
 
 `ayadn -ms pasteapp` 
@@ -47,11 +43,3 @@ List all your channel aliases.
 `ayadn alias list`
 
 `ayadn -A list`
-
-## IMPORT
-
-Import a previously backed-up list of aliases.
-
-`ayadn alias import '/Users/blah/backups/aliases.db'`
-
-`ayadn -A import '/Users/blah/backups/aliases.db'`