git.sesse.net Git - ffmpeg/blob - 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 Note that the ffmpeg-devel mailing list does not require you to subscribe
  68 to send a message or patch, but ffmpeg-user and libav-user do require
  69 subscription.
  70
  71 @chapter Subscribing / Unsubscribing
  72
  73 @anchor{How do I subscribe?}
  74 @section How do I subscribe?
  75
  76 Email @email{ffmpeg-user-request@@ffmpeg.org} with the subject
  77 @emph{subscribe}.
  78
  79 Or visit the @url{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-user/, ffmpeg-user mailing list info page}
  80 and refer to the @emph{Subscribing to ffmpeg-user} section.
  81
  82 The process is the same for the other mailing lists.
  83
  84 @section How do I unsubscribe?
  85
  86 Email @email{ffmpeg-user-request@@ffmpeg.org} with subject @emph{unsubscribe}.
  87
  88 Or visit the @url{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-user/, ffmpeg-user mailing list info page},
  89 scroll to bottom of page, enter your email address in the box, and click
  90 the @emph{Unsubscribe or edit options} button.
  91
  92 The process is the same for the other mailing lists.
  93
  94 Please avoid asking a mailing list admin to unsubscribe you unless you
  95 are absolutely unable to do so by yourself. See @ref{Who do I contact if I have a problem with the mailing list?}
  96
  97 @chapter Moderation Queue
  98 @anchor{Why is my message awaiting moderator approval?}
  99 @section Why is my message awaiting moderator approval?
 100
 101 Some messages are automatically held in the @emph{moderation queue} and
 102 must be manually approved by a mailing list admin:
 103
 104 These are:
 105
 106 @itemize
 107
 108 @item
 109 Messages that exceed the @ref{What is the message size limit?, message size limit}.
 110
 111 @item
 112 Messages from users whose accounts have been set with the @emph{moderation flag}
 113 (very rarely occurs, but may if a user repeatedly ignores the rules
 114 or is abusive towards others).
 115 @end itemize
 116
 117 @section How long does it take for my message in the moderation queue to be approved?
 118
 119 The queue is usually checked daily to several times a week.
 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 Nabble interface which presents the
 161 mailing lists in a typical forum layout.
 162
 163 There are also numerous third-party help sites such as Super User and
 164 r/ffmpeg on reddit.
 165
 166 @anchor{What is top-posting?}
 167 @section What is top-posting?
 168
 169 See @url{https://en.wikipedia.org/wiki/Posting_style#Top-posting}.
 170
 171 Instead, use trimmed interleaved/inline replies (@url{https://lists.ffmpeg.org/pipermail/ffmpeg-user/2017-April/035849.html, example}).
 172
 173 @anchor{What is the message size limit?}
 174 @section What is the message size limit?
 175
 176 The message size limit is 1000 kilobytes. Please provide links to larger files
 177 instead of attaching them.
 178
 179 @section Where can I upload sample files?
 180
 181 Anywhere that is not too annoying for us to use.
 182
 183 Google Drive and Dropbox are acceptable if you need a file host, and
 184 0x0.st is good for files under 256 MiB.
 185
 186 Small, short samples are preferred if possible.
 187
 188 @section Will I receive spam if I send and/or subscribe to a mailing list?
 189
 190 Highly unlikely.
 191
 192 @itemize
 193 @item
 194 The list of subscribed users is not public.
 195
 196 @item
 197 Email addresses in the archives are obfuscated.
 198
 199 @item
 200 Several unique test email accounts were utilized and none have yet
 201 received any spam.
 202 @end itemize
 203
 204 However, you may see a spam in the mailing lists on rare occasions:
 205
 206 @itemize
 207 @item
 208 Spam in the moderation queue may be accidentally approved due to human
 209 error.
 210
 211 @item
 212 There have been a few messages from subscribed users who had their own
 213 email addresses hacked and spam messages from (or appearing to be from)
 214 the hacked account were sent to their contacts (a mailing list being a
 215 contact in these cases).
 216
 217 @item
 218 If you are subscribed to the bug tracker mailing list (ffmpeg-trac) you
 219 may see the occasional spam as a false bug report, but we take measures
 220 to try to prevent this.
 221 @end itemize
 222
 223 @section How do I filter mailing list messages?
 224
 225 Use the @emph{List-Id}. For example, the ffmpeg-user mailing list is
 226 @t{ffmpeg-user.ffmpeg.org}. You can view the List-Id in the raw message
 227 or headers.
 228
 229 You can then filter the mailing list messages to their own folder.
 230
 231 @chapter Rules and Etiquette
 232
 233 @section What are the rules and the proper etiquette?
 234
 235 There may seem to be many things to remember, but we want to help and
 236 following these guidelines will allow you to get answers more quickly
 237 and help avoid getting ignored.
 238
 239 @itemize
 240 @item
 241 Always show your actual, unscripted @command{ffmpeg} command and the
 242 complete, uncut console output from your command.
 243
 244 @item
 245 Use the most simple and minimal command that still shows the issue you
 246 are encountering.
 247
 248 @item
 249 Provide all necessary information so others can attempt to duplicate
 250 your issue. This includes the actual command, complete uncut console
 251 output, and any inputs that are required to duplicate the issue.
 252
 253 @item
 254 Use the latest @command{ffmpeg} build you can get. See the @url{https://ffmpeg.org/download.html, FFmpeg Download}
 255 page for links to recent builds for Linux, macOS, and Windows. Or
 256 compile from the current git master branch.
 257
 258 @item
 259 Avoid @url{https://en.wikipedia.org/wiki/Posting_style#Top-posting, top-posting}.
 260 Also see @ref{What is top-posting?}
 261
 262 @item
 263 Avoid hijacking threads. Thread hijacking is replying to a message and
 264 changing the subject line to something unrelated to the original thread.
 265 Most email clients will still show the renamed message under the
 266 original thread. This can be confusing and these types of messages are
 267 often ignored.
 268
 269 @item
 270 Do not send screenshots. Copy and paste console text instead of making
 271 screenshots of the text.
 272
 273 @item
 274 Avoid sending email disclaimers and legalese if possible as this is a
 275 public list.
 276
 277 @item
 278 Avoid using the @code{-loglevel debug}, @code{-loglevel quiet}, and
 279 @command{-hide_banner} options unless requested to do so.
 280
 281 @item
 282 If you attach files avoid compressing small files. Uncompressed is
 283 preferred.
 284
 285 @item
 286 Please do not send HTML-only messages. The mailing list will ignore the
 287 HTML component of your message. Most mail clients will automatically
 288 include a text component: this is what the mailing list will use.
 289
 290 @item
 291 Configuring your mail client to break lines after 70 or so characters is
 292 recommended.
 293
 294 @item
 295 Avoid sending the same message to multiple mailing lists.
 296
 297 @item
 298 Please follow our @url{https://ffmpeg.org/developer.html#Code-of-conduct, Code of Conduct}.
 299 @end itemize
 300
 301 @chapter Help
 302
 303 @section Why am I not receiving any messages?
 304
 305 Some email providers have blacklists or spam filters that block or mark
 306 the mailing list messages as false positives. Unfortunately, the user is
 307 often not aware of this and is often out of their control.
 308
 309 When possible we attempt to notify the provider to be removed from the
 310 blacklists or filters.
 311
 312 @section Why are my sent messages not showing up?
 313
 314 Excluding @ref{Why is my message awaiting moderator approval?, messages that are held in the moderation queue}
 315 there are a few other reasons why your messages may fail to appear:
 316
 317 @itemize
 318 @item
 319 HTML-only messages are ignored by the mailing lists. Most mail clients
 320 automatically include a text component alongside HTML email: this is what
 321 the mailing list will use. If it does not then consider your client to be
 322 broken, because sending a text component along with the HTML component to
 323 form a multi-part message is recommended by email standards.
 324
 325 @item
 326 Check your spam folder.
 327 @end itemize
 328
 329 @anchor{Who do I contact if I have a problem with the mailing list?}
 330 @section Who do I contact if I have a problem with the mailing list?
 331
 332 Send a message to @email{ffmpeg-user-owner@@ffmpeg.org}.
 333
 334 @bye