applications/tg
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #15 from tazhate/help

Browse Source 
reformat of readme
This commit is contained in:
vysheng 2013-11-22 12:48:02 -08:00
commit af2a0b717b
1 changed files with 34 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -43,31 +43,52 @@ By default public key is stored in the same folder named tg.pub:
./telegram -k tg.pub ./telegram -k tg.pub
#### Supported commands: Client support TAB completion and command history.
### Supported commands
#### Messaging
* **msg** \<peer\> Text - sends message to this peer * **msg** \<peer\> Text - sends message to this peer
* **contact_list** - prints info about users in your contact list * **fwd** \<user\> \<msg-seqno\> - forward message to user. You can see message numbers starting client with -N
* **stats** - just for debugging * **add_contact** \<phone-number\> \<first-name\> \<last-name\> - tries to add contact to contact-list by phone
* **history** \<peer\> [limit] - prints history (and marks it as read). Default limit = 40 * **rename_contact** \<user\> \<first-name\> \<last-name\> - tries to rename contact. If you have another device it will be a fight
* **dialog_list** - prints info about your dialogs * **mark_read** \<peer\> - mark read all received messages with peer
#### Multimedia
* **send_photo** \<peer\> \<photo-file-name\> - sends photo to peer * **send_photo** \<peer\> \<photo-file-name\> - sends photo to peer
* **send_video** \<peer\> \<video-file-name\> - sends video to peer * **send_video** \<peer\> \<video-file-name\> - sends video to peer
* **send_text** \<peer\> \<text-file-name> - sends text file as plain messages * **send_text** \<peer\> \<text-file-name> - sends text file as plain messages
* **load_photo**/load_video/load_video_thumb \<msg-seqno\> - loads photo/video to download dir
* **view_photo**/view_video/view_video_thumb \<msg-seqno\> - loads photo/video to download dir and starts system default viewer
#### Group chat options
* **chat_info** \<chat\> - prints info about chat * **chat_info** \<chat\> - prints info about chat
* **user_info** \<user\> - prints info about user
* **fwd** \<user\> \<msg-seqno\> - forward message to user. You can see message numbers starting client with -N
* **chat_add_user** \<chat\> \<user\> - add user to chat * **chat_add_user** \<chat\> \<user\> - add user to chat
* **chat_del_user** \<chat\> \<user\> - remove user from chat * **chat_del_user** \<chat\> \<user\> - remove user from chat
* **rename_chat** \<chat\> \<new-name\> * **rename_chat** \<chat\> \<new-name\>
* **load_photo**/load_video/load_video_thumb \<msg-seqno\> - loads photo/video to download dir
* **view_photo**/view_video/view_video_thumb \<msg-seqno\> - loads photo/video to download dir and starts system default viewer #### Search
* **search** \<peer\> pattern - searches pattern in messages with peer * **search** \<peer\> pattern - searches pattern in messages with peer
* **global_search** pattern - searches pattern in all messages * **global_search** pattern - searches pattern in all messages
* **mark_read** \<peer\> - mark read all received messages with peer
* **add_contact** \<phone-number\> \<first-name\> \<last-name\> - tries to add contact to contact-list by phone #### Secret chat
* **create_secret_chat** \<user\> - creates secret chat with this user * **create_secret_chat** \<user\> - creates secret chat with this user
* **rename_contact** \<user\> \<first-name\> \<last-name\> - 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** \<secret_chat\> - prints visualization of encryption key. You should compare it to your partner's one * **visualize_key** \<secret_chat\> - prints visualization of encryption key. You should compare it to your partner's one
#### Stats and various info
* **user_info** \<user\> - prints info about user
* **history** \<peer\> [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 * **show_license** - prints contents of GPLv2
* **help** - prints this help * **help** - prints this help