-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathtwitter-format.7
164 lines (164 loc) · 4.27 KB
/
twitter-format.7
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "TWITTER\-FORMAT" "7" "August 2013" "TWITTER FORMAT" "TWITTER TWEET FORMAT"
.
.SH "NAME"
\fBtwitter\-format\fR \- syntax and conventions used in Twitter statuses
.
.SH "SYNOPSIS"
\fImessage\fR
.
.br
\fB@\fR\fIuser\fR \fImessage\fR
.
.br
.
.P
\fB\.@\fR\fIuser\fR \fImessage\fR
.
.br
\fBRT\fR \fB@\fR\fIuser\fR \fImessage\fR
.
.br
\fBMT\fR \fB@\fR\fIuser\fR \fImessage\fR
.
.br
\fBOH:\fR \fIquote\fR
.
.br
\fB#\fR\fIhashtag\fR
.
.br
\fB$\fR\fIticker\fR
.
.br
\fImessage\fR \fB^\fR\fIsigned\fR
.
.SH "DESCRIPTION"
Twitter supports simple messages as sequences of characters\. In addition to the syntax for replying to a tweet poster, there are various conventions for non\-reply messages\.
.
.SH "PLAIN TWEETS"
\fImessage\fR
.
.P
The core message is a string of characters which does not begin with \fB@\fR\.
.
.P
There are additional conventions within a message itself\. See the section on \fIMESSAGE CONVENTIONS\fR\.
.
.SH "@\-REPLIES"
\fB@\fR\fIuser\fR \fImessage\fR
.
.P
If \fImessage\fR is preceded with \fB@\fR\fIuser\fR, the tweet will be visible to the user with account name \fIuser\fR and any users who are following both you (as the sender) and \fIuser\fR\.
.
.SH "MENTION\-REPLY"
\fB\.@\fR\fIuser\fR \fImessage\fR
.
.P
If the leading \fB@\fR is preceded by any other character, commonly \fB\.\fR, the message is no longer an @reply tweet and will be visible to anyone following you (as the sender)\.
.
.P
This convention is frequently used to reply to \fIuser\fR\'s tweet while making your reply visible to others, or to refer to \fIuser\fR in a "new" tweet without causing its contents to become invisible to your follows\.
.
.SH "RETWEETING"
\fBRT\fR \fB@\fR\fIuser\fR \fImessage\fR
.
.P
If \fB@\fR is preceded by \fBRT\fR, this is a convention indicating that you are \fIretweeting\fR someone\'s \fImessage\fR\. Doing so makes \fImessage\fR available to all your followers\.
.
.P
\fBMT\fR \fB@\fR\fIuser\fR \fImessage\fR
.
.P
\fBMT\fR, for \fBm\fRodified \fBt\fRweet, is used when the \fImessage\fR would have exceeded the character limit\. This is usually seen in combination with some added comment, otherwise a simple retweet would suffice\.
.
.SH "OVERHEARD SENTENCES"
\fBOH:\fR \fIquote\fR
.
.br
\fBOH\fR \fB@\fR\fIuser\fR\fB:\fR \fIquote\fR
.
.P
If \fImessage\fR begins with \fBOH:\fR, then what follows is a \fIquote\fR (which may or may not be wrapped in actual quotation marks) which has been \fBO\fRver\fBH\fReard\.
.
.P
Sometimes the user is included, such as:
.
.P
\fBOH\fR \fB@\fR\fIuser\fR\fB:\fR \fIquote\fR
.
.P
This means, of course, that \fIuser\fR was overheard saying \fIquote\fR\.
.
.SH "SIGNATURES"
\fImessage\fR \fB^\fR\fIsigned\fR
.
.P
Sometimes a \fImessage\fR ends with a \fI^signature\fR, indicating which user wrote the tweet\. This is used to differentiate between many users on a shared account, most often company accounts\.
.
.SH "MESSAGE CONVENTIONS"
\fB@\fR\fIusermention\fR
.
.P
\fImessage\fR can itself contain \fB@\fR\fIuser\fR references, called \fImentions\fR, which \fIuser\fR can see\.
.
.P
\fB#\fR\fIhashtag\fR
.
.P
Any words in \fImessage\fR which begin with \fB#\fR are called \fIhashtags\fR and are used to tag the message as related to some particular topic\.
.
.P
\fB$\fR\fIticker\fR
.
.P
Similar to a hashtags, \fB$\fR is used to refer to stock ticker symbols, such as \fB$\fRAAPL for Apple, Inc\.
.
.SH "EXAMPLES"
.
.TP
\fBSimple message\fR
I\'m on twitter!
.
.TP
\fBReply\fR
@twitter agreed\.
.
.TP
\fBOverheard\fR
OH: "140 characters? That\'ll never take off\."
.
.TP
\fBOverheard with a user mention\fR
OH @typed: "A man page? For Twitter? That\'s stupid\."
.
.TP
\fBRetweet\fR
RT @jack just setting up my twttr
.
.TP
\fBHashtag\fR
Writing a man page for tweets\. #pointless
.
.TP
\fBModified tweet\fR
Not bad! MT @typed man page updated\.
.
.TP
\fBSigned tweet\fR
We\'ll take a look at that for you\. ^JS
.
.TP
\fBStock ticker\fR
Whoa, $AAPL just rallied!
.
.SH "ABOUT THIS MAN PAGE"
This \fBtwitter\-format(7)\fR man page was written for fun by Adam Prescott \fIhttp://aprescott\.com/\fR\. You can find its source on GitHub \fIhttps://github\.com/aprescott/twitter\-format\fR\.
.
.P
It is released under the terms of the MIT License with the copyright notice:
.
.P
Copyright (c) 2012\-2013 Adam Prescott <adam@aprescott\.com>