From 66e26f9a7ae858d328e49f520b6b298012312f31 Mon Sep 17 00:00:00 2001 From: tazhate Date: Fri, 22 Nov 2013 23:49:59 +0400 Subject: [PATCH] new format of readme --- README.md | 45 ++++++++++++++++++++++++++++++++------------- 1 file changed, 32 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index f84e18b..ffc66e2 100644 --- a/README.md +++ b/README.md @@ -45,31 +45,50 @@ By default public key is stored in the same folder named tg.pub: Client support TAB completion and command history. -#### Supported commands: +#### Supported commands + +## Messaging + * **msg** \ Text - sends message to this peer -* **contact_list** - prints info about users in your contact list -* **stats** - just for debugging -* **history** \ [limit] - prints history (and marks it as read). Default limit = 40 -* **dialog_list** - prints info about your dialogs +* **fwd** \ \ - forward message to user. You can see message numbers starting client with -N +* **add_contact** \ \ \ - tries to add contact to contact-list by phone +* **rename_contact** \ \ \ - tries to rename contact. If you have another device it will be a fight +* **mark_read** \ - mark read all received messages with peer + +## Multimedia + * **send_photo** \ \ - sends photo to peer * **send_video** \ \ - sends video to peer * **send_text** \ \ - sends text file as plain messages +* **load_photo**/load_video/load_video_thumb \ - loads photo/video to download dir +* **view_photo**/view_video/view_video_thumb \ - loads photo/video to download dir and starts system default viewer + + +## Group chat options + * **chat_info** \ - prints info about chat -* **user_info** \ - prints info about user -* **fwd** \ \ - forward message to user. You can see message numbers starting client with -N * **chat_add_user** \ \ - add user to chat * **chat_del_user** \ \ - remove user from chat * **rename_chat** \ \ -* **load_photo**/load_video/load_video_thumb \ - loads photo/video to download dir -* **view_photo**/view_video/view_video_thumb \ - loads photo/video to download dir and starts system default viewer + +## Search + * **search** \ pattern - searches pattern in messages with peer * **global_search** pattern - searches pattern in all messages -* **mark_read** \ - mark read all received messages with peer -* **add_contact** \ \ \ - tries to add contact to contact-list by phone + +## Secret chat + * **create_secret_chat** \ - creates secret chat with this user -* **rename_contact** \ \ \ - tries to rename contact. If you have another device it will be a fight -* **suggested_contacts** - print info about contacts, you have max common friends * **visualize_key** \ - prints visualization of encryption key. You should compare it to your partner's one + +## Stats and various info + +* **user_info** \ - prints info about user +* **history** \ [limit] - prints history (and marks it as read). Default limit = 40 +* **dialog_list** - prints info about your dialogs +* **contact_list** - prints info about users in your contact list +* **suggested_contacts** - print info about contacts, you have max common friends +* **stats** - just for debugging * **show_license** - prints contents of GPLv2 * **help** - prints this help