lavfi/colorspace_common: add ifdef check to be more compatible.
[ffmpeg.git] / doc / mailing-list-faq.texi
1 \input texinfo @c -*- texinfo -*-
2 @documentencoding UTF-8
3
4 @settitle FFmpeg Mailing List FAQ
5 @titlepage
6 @center @titlefont{FFmpeg Mailing List FAQ}
7 @end titlepage
8
9 @top
10
11 @contents
12
13 @chapter General Questions
14
15 @section What is a mailing list?
16
17 A mailing list is not much different than emailing someone, but the
18 main difference is that your message is received by everyone who
19 subscribes to the list. It is somewhat like a forum but in email form.
20
21 See the @url{https://lists.ffmpeg.org/pipermail/ffmpeg-user/, ffmpeg-user archives}
22 for examples.
23
24 @section What type of questions can I ask?
25
26 @itemize
27 @item
28 @url{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-user/, ffmpeg-user}:
29 For questions involving unscripted usage or compilation of the FFmpeg
30 command-line tools (@command{ffmpeg}, @command{ffprobe}, @command{ffplay}).
31
32 @item
33 @url{https://lists.ffmpeg.org/mailman/listinfo/libav-user/, libav-user}:
34 For questions involving the FFmpeg libav* libraries (libavcodec,
35 libavformat, libavfilter, etc).
36
37 @item
38 @url{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-devel/, ffmpeg-devel}:
39 For discussions involving the development of FFmpeg and for submitting
40 patches. User questions should be asked at ffmpeg-user or libav-user.
41 @end itemize
42
43 To report a bug see @url{https://ffmpeg.org/bugreports.html}.
44
45 We cannot provide help for scripts and/or third-party tools.
46
47 @anchor{How do I ask a question or send a message to a mailing list?}
48 @section How do I ask a question or send a message to a mailing list?
49
50 First you must @ref{How do I subscribe?, subscribe}. Then all you have to do is
51 send an email:
52
53 @itemize
54 @item
55 Email @email{ffmpeg-user@@ffmpeg.org} to send a message to the
56 ffmpeg-user mailing list.
57
58 @item
59 Email @email{libav-user@@ffmpeg.org} to send a message to the
60 libav-user mailing list.
61
62 @item
63 Email @email{ffmpeg-devel@@ffmpeg.org} to send a message to the
64 ffmpeg-devel mailing list.
65 @end itemize
66
67 @chapter Subscribing / Unsubscribing
68
69 @anchor{How do I subscribe?}
70 @section How do I subscribe?
71
72 Email @email{ffmpeg-user-request@@ffmpeg.org} with the subject
73 @emph{subscribe}.
74
75 Or visit the @url{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-user/, ffmpeg-user mailing list info page}
76 and refer to the @emph{Subscribing to ffmpeg-user} section.
77
78 The process is the same for the other mailing lists.
79
80 @section How do I unsubscribe?
81
82 Email @email{ffmpeg-user-request@@ffmpeg.org} with subject @emph{unsubscribe}.
83
84 Or visit the @url{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-user/, ffmpeg-user mailing list info page},
85 scroll to bottom of page, enter your email address in the box, and click
86 the @emph{Unsubscribe or edit options} button.
87
88 The process is the same for the other mailing lists.
89
90 Please avoid asking a mailing list admin to unsubscribe you unless you
91 are absolutely unable to do so by yourself. See @ref{Who do I contact if I have a problem with the mailing list?}
92
93 Note that it is possible to temporarily halt message delivery (vacation mode).
94 See @ref{How do I disable mail delivery without unsubscribing?}
95
96 @chapter Moderation Queue
97 @anchor{Why is my message awaiting moderator approval?}
98 @section Why is my message awaiting moderator approval?
99
100 Some messages are automatically held in the @emph{moderation queue} and
101 must be manually approved by a mailing list admin:
102
103 These are:
104
105 @itemize
106
107 @item
108 Messages that exceed the @ref{What is the message size limit?, message size limit}.
109
110 @item
111 Messages from users whose accounts have been set with the @emph{moderation flag}
112 (very rarely occurs, but may if a user repeatedly ignores the rules
113 or is abusive towards others).
114 @end itemize
115
116 @section How long does it take for my message in the moderation queue to be approved?
117
118 The queue is not checked on a regular basis. You can ask on the
119 @t{#ffmpeg-devel} IRC channel on Freenode for someone to approve your message.
120
121 @anchor{How do I delete my message in the moderation queue?}
122 @section How do I delete my message in the moderation queue?
123
124 You should have received an email with the subject @emph{Your message to <mailing list name> awaits moderator approval}.
125 A link is in the message that will allow you to delete your message
126 unless a mailing list admin already approved or rejected it.
127
128 @chapter Archives
129
130 @anchor{Where are the archives?}
131 @section Where are the archives?
132
133 See the @emph{Archives} section on the @url{https://ffmpeg.org/contact.html, FFmpeg Contact}
134 page for links to all FFmpeg mailing list archives.
135
136 Note that the archives are split by month. Discussions that span
137 several months will be split into separate months in the archives.
138
139 @section How do I reply to a message in the archives?
140
141 Click the email link at the top of the message just under the subject
142 title. The link will provide the proper headers to keep the message
143 within the thread.
144
145 Note that you must be subscribed to send a message to the ffmpeg-user or
146 libav-user mailing lists.
147
148 @section How do I search the archives?
149
150 Perform a site search using your favorite search engine. Example:
151
152 @t{site:lists.ffmpeg.org/pipermail/ffmpeg-user/ "search term"}
153
154 @chapter Other
155
156 @section Is there an alternative to the mailing list?
157
158 You can ask for help in the official @t{#ffmpeg} IRC channel on Freenode.
159
160 Some users prefer the third-party @url{http://www.ffmpeg-archive.org/, Nabble}
161 interface which presents the mailing lists in a typical forum layout.
162
163 There are also numerous third-party help sites such as
164 @url{https://superuser.com/tags/ffmpeg, Super User} and
165 @url{https://www.reddit.com/r/ffmpeg/, r/ffmpeg on reddit}.
166
167 @anchor{What is top-posting?}
168 @section What is top-posting?
169
170 See @url{https://en.wikipedia.org/wiki/Posting_style#Top-posting}.
171
172 Instead, use trimmed interleaved/inline replies (@url{https://lists.ffmpeg.org/pipermail/ffmpeg-user/2017-April/035849.html, example}).
173
174 @anchor{What is the message size limit?}
175 @section What is the message size limit?
176
177 The message size limit is 1000 kilobytes. Please provide links to larger files
178 instead of attaching them.
179
180 @section Where can I upload sample files?
181
182 Anywhere that is not too annoying for us to use.
183
184 Google Drive and Dropbox are acceptable if you need a file host, and
185 @url{https://0x0.st/, 0x0.st} is good for files under 256 MiB.
186
187 Small, short samples are preferred if possible.
188
189 @section Will I receive spam if I send and/or subscribe to a mailing list?
190
191 Highly unlikely.
192
193 @itemize
194 @item
195 The list of subscribed users is not public.
196
197 @item
198 Email addresses in the archives are obfuscated.
199
200 @item
201 Several unique test email accounts were utilized and none have yet
202 received any spam.
203 @end itemize
204
205 However, you may see a spam in the mailing lists on rare occasions:
206
207 @itemize
208 @item
209 Spam in the moderation queue may be accidentally approved due to human
210 error.
211
212 @item
213 There have been a few messages from subscribed users who had their own
214 email addresses hacked and spam messages from (or appearing to be from)
215 the hacked account were sent to their contacts (a mailing list being a
216 contact in these cases).
217
218 @item
219 If you are subscribed to the bug tracker mailing list (ffmpeg-trac) you
220 may see the occasional spam as a false bug report, but we take measures
221 to try to prevent this.
222 @end itemize
223
224 @section How do I filter mailing list messages?
225
226 Use the @emph{List-Id}. For example, the ffmpeg-user mailing list is
227 @t{ffmpeg-user.ffmpeg.org}. You can view the List-Id in the raw message
228 or headers.
229
230 You can then filter the mailing list messages to their own folder.
231
232 @anchor{How do I disable mail delivery without unsubscribing?}
233 @section How do I disable mail delivery without unsubscribing?
234
235 Sometimes you may want to temporarily stop receiving all mailing list
236 messages. This "vacation mode" is simple to do:
237
238 @enumerate
239 @item
240 Go to the @url{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-user/, ffmpeg-user mailing list info page}
241
242 @item
243 Enter your email address in the box at very bottom of the page and click the
244 @emph{Unsubscribe or edit options} box.
245
246 @item
247 Enter your password and click the @emph{Log in} button.
248
249 @item
250 Look for the @emph{Mail delivery} option. Here you can disable/enable mail
251 delivery. If you check @emph{Set globally} it will apply your choice to all
252 other FFmpeg mailing lists you are subscribed to.
253 @end enumerate
254
255 Alternatively, from your subscribed address, send a message to @email{ffmpeg-user-request@@ffmpeg.org}
256 with the subject @emph{set delivery off}. To re-enable mail delivery send a
257 message to @email{ffmpeg-user-request@@ffmpeg.org} with the subject
258 @emph{set delivery on}.
259
260 @chapter Rules and Etiquette
261
262 @section What are the rules and the proper etiquette?
263
264 There may seem to be many things to remember, but we want to help and
265 following these guidelines will allow you to get answers more quickly
266 and help avoid getting ignored.
267
268 @itemize
269 @item
270 Always show your actual, unscripted @command{ffmpeg} command and the
271 complete, uncut console output from your command.
272
273 @item
274 Use the most simple and minimal command that still shows the issue you
275 are encountering.
276
277 @item
278 Provide all necessary information so others can attempt to duplicate
279 your issue. This includes the actual command, complete uncut console
280 output, and any inputs that are required to duplicate the issue.
281
282 @item
283 Use the latest @command{ffmpeg} build you can get. See the @url{https://ffmpeg.org/download.html, FFmpeg Download}
284 page for links to recent builds for Linux, macOS, and Windows. Or
285 compile from the current git master branch.
286
287 @item
288 Avoid @url{https://en.wikipedia.org/wiki/Posting_style#Top-posting, top-posting}.
289 Also see @ref{What is top-posting?}
290
291 @item
292 Avoid hijacking threads. Thread hijacking is replying to a message and
293 changing the subject line to something unrelated to the original thread.
294 Most email clients will still show the renamed message under the
295 original thread. This can be confusing and these types of messages are
296 often ignored.
297
298 @item
299 Do not send screenshots. Copy and paste console text instead of making
300 screenshots of the text.
301
302 @item
303 Avoid sending email disclaimers and legalese if possible as this is a
304 public list.
305
306 @item
307 Avoid using the @code{-loglevel debug}, @code{-loglevel quiet}, and
308 @command{-hide_banner} options unless requested to do so.
309
310 @item
311 If you attach files avoid compressing small files. Uncompressed is
312 preferred.
313
314 @item
315 Please do not send HTML-only messages. The mailing list will ignore the
316 HTML component of your message. Most mail clients will automatically
317 include a text component: this is what the mailing list will use.
318
319 @item
320 Configuring your mail client to break lines after 70 or so characters is
321 recommended.
322
323 @item
324 Avoid sending the same message to multiple mailing lists.
325
326 @item
327 Please follow our @url{https://ffmpeg.org/developer.html#Code-of-conduct, Code of Conduct}.
328 @end itemize
329
330 @chapter Help
331
332 @section Why am I not receiving any messages?
333
334 Some email providers have blacklists or spam filters that block or mark
335 the mailing list messages as false positives. Unfortunately, the user is
336 often not aware of this and is often out of their control.
337
338 When possible we attempt to notify the provider to be removed from the
339 blacklists or filters.
340
341 @section Why are my sent messages not showing up?
342
343 Excluding @ref{Why is my message awaiting moderator approval?, messages that are held in the moderation queue}
344 there are a few other reasons why your messages may fail to appear:
345
346 @itemize
347 @item
348 HTML-only messages are ignored by the mailing lists. Most mail clients
349 automatically include a text component alongside HTML email: this is what
350 the mailing list will use. If it does not then consider your client to be
351 broken, because sending a text component along with the HTML component to
352 form a multi-part message is recommended by email standards.
353
354 @item
355 Check your spam folder.
356 @end itemize
357
358 @anchor{Who do I contact if I have a problem with the mailing list?}
359 @section Who do I contact if I have a problem with the mailing list?
360
361 Send a message to @email{ffmpeg-user-owner@@ffmpeg.org}.
362
363 @bye