Signed-off-by: Lou Logan <l...@lrcd.com>
---
doc/Makefile | 1 +
doc/mailing-list-faq.texi | 204 ++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 205 insertions(+)
create mode 100644 doc/mailing-list-faq.texi
diff --git a/doc/Makefile b/doc/Makefile
index b670f0bd4c..9a4d225e65 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -24,6 +24,7 @@ HTMLPAGES = $(AVPROGS-yes:%=doc/%.html)
$(AVPROGS-yes:%=doc/%-all.html) $(COMP
doc/fate.html \
doc/general.html \
doc/git-howto.html \
+ doc/mailing-list-faq.html \
doc/nut.html \
doc/platform.html \
diff --git a/doc/mailing-list-faq.texi b/doc/mailing-list-faq.texi
new file mode 100644
index 0000000000..a047fdcd51
--- /dev/null
+++ b/doc/mailing-list-faq.texi
@@ -0,0 +1,204 @@
+\input texinfo @c -*- texinfo -*-
+@documentencoding UTF-8
+
+@settitle FFmpeg Mailing List FAQ
+@titlepage
+@center @titlefont{FFmpeg Mailing List FAQ}
+@end titlepage
+
+@top
+
+@contents
+
+@chapter General Questions
+
+@section What is a mailing list?
+
+A mailing list is not much different than emailing someone, but the
+main difference is that your message is received by everyone who
+subscribes to the list. It is somewhat like a forum but in email form.
+
+See the @url{https://lists.ffmpeg.org/pipermail/ffmpeg-user/, ffmpeg-user
archives}
+for examples.
+
+@section What type of questions can I ask?
+
+@url{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-user/, ffmpeg-user}:
+For questions involving unscripted usage or compilation of the FFmpeg
+command-line tools (@command{ffmpeg}, @command{ffprobe}, @command{ffplay},
+@command{ffserver}).
+
+@url{https://lists.ffmpeg.org/mailman/listinfo/libav-user/, libav-user}:
+For questions involving the FFmpeg libav* libraries (libavcodec,
+libavformat, libavfilter, etc).
+
+@url{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-devel/, ffmpeg-devel}:
+Only for discussions involving the development of FFmpeg and for
+submitting patches. User questions should be asked at ffmpeg-user or
+libav-user.
+
+To report a bug see @url{https://ffmpeg.org/bugreports.html}.
+
+We cannot provide help for scripts and/or third-party tools.
+
+@section How do I ask a question or send a message to the mailing list?
+
+E-mail @email{ffmpeg-user@@ffmpeg.org}.
+
+If you are not subscribed to the mailing list then your question must be
+manually approved. Approval may take several days, but the wait is
+usually less. If you want the message to be sent with no delay then you
+must subscribe first.
+
+Please do not send a message, subscribe, and re-send the message: this
+results in duplicates, causes more work for the admins, and may lower
+your chance at getting an answer. However, you may do so if you first
+@ref{How do I delete my message in the moderation queue, delete your original
message from the moderation queue}.
+
+@chapter Subscribing / Unsubscribing
+
+@section Do I need to subscribe?
+
+No.
+
+However, you will not directly receive replies unless you ask to be CCd
+in your message, but on occasion users will forget to CC you when
+replying. Alternatively, you can view and reply to messages via the
+@ref{Where are the archives, archives}.
+
+@section How do I subscribe?
+
+Email @email{ffmpeg-user-request@@ffmpeg.org} with the subject
+@emph{subscribe}.
+
+Or visit the @url{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-user/,
ffmpeg-user mailing list info page}
+and refer to the @emph{Subscribing to ffmpeg-user} section.
+
+The process is the same for the other mailing lists.
+
+@section How do I unsubscribe?
+
+Email @email{ffmpeg-user-request@@ffmpeg.org} with subject @emph{unsubscribe}.
+
+Or visit the @url{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-user/,
ffmpeg-user mailing list info page},
+scroll to bottom of page, enter your email address in the box, and click
+the @emph{Unsubscribe or edit options} button.
+
+The process is the same for the other mailing lists.
+
+Please avoid asking a mail admin to unsubscribe you: there should be no
+reason to do so.
+
+@anchor{How do I delete my message in the moderation queue}
+@section How do I delete my message in the moderation queue?
+
+You should have received an email with the subject @emph{Your message to
ffmpeg-user awaits moderator approval}.
+A link is in the message that will allow you to delete your message
+unless a mail admin already approved or rejected it.
+
+@chapter Archives
+
+@anchor{Where are the archives}
+@section Where are the archives?
+
+See the @emph{Archives} section on the @url{https://ffmpeg.org/contact.html,
FFmpeg Contact}
+page for links to all FFmpeg mailing list archives.
+
+Note that the archives are split by month. Discussions that span
+several months will be split into separate months.
+
+@section How do I reply to a message in the archives?
+
+Click the email link at the top of the message just under the subject
+title. The link will provide the proper headers to keep the message
+within the thread.
+
+@section Is there an alternative to the mailing list?
+
+You can ask for help in the official #ffmpeg IRC channel on Freenode.
+
+Some users prefer the third-party Nabble or Gmane interfaces which
+present the mailing lists in a typical forum layout.
+
+@section How do I search the archives?
+
+Perform a site seach using your favorite search engine. Example:
+
+@t{site:lists.ffmpeg.org/pipermail/ffmpeg-user/ "search term"}
+
+@chapter Other
+
+@anchor{What is top-posting}
+@section What is top-posting?
+
+See @url{https://en.wikipedia.org/wiki/Posting_style#Top-posting}.
+
+Instead, use trimmed interleaved/inline replies
(@url{https://lists.ffmpeg.org/pipermail/ffmpeg-user/2017-April/035849.html,
example}).
+
+@section What is the message size limit?
+
+The message size limit is 500k. Please provide links to larger files
+instead of attaching them. Dropbox and Google Drive are acceptable
+if you need a file host.
+
+@section What are the rules and the proper etiquette?
+
+There may seem to be many things to remember, but we want to help and
+following these guidelines will allow you to get answers more quickly
+and avoid getting ignored.
+
+@itemize
+@item
+Always show your actual, unscripted @command{ffmpeg} command and the
+complete console output from your command.
+
+@item
+Use the most simple and minimal command that still shows the issue you
+are encountering.
+
+@item
+Provide all necessary information so others can attempt to duplicate
+your issue. This includes the actual command, complete console output,
+and any inputs that are required to duplicate the issue.
+
+@item
+Use the latest @command{ffmpeg} build you can get. See the
@url{https://ffmpeg.org/download.html, FFmpeg Download}
+page for links to recent builds for Linux, macOS, and Windows. Or
+compile from the current git master branch.
+
+@item
+Avoid @url{https://en.wikipedia.org/wiki/Posting_style#Top-posting,
top-posting}.
+Also see @ref{What is top-posting, What is top-posting?}
+
+@item
+Avoid hijacking threads. Thread hijacking is replying to a message and
+changing the subject line to something unrelated to the original thread.
+Most email clients will still show the renamed message under the
+original thread. This can be confusing and these types of messages are
+often ignored.
+
+@item
+Do not send screenshots. Copy and paste console text instead of making
+screenshots of the text.
+
+@item
+Avoid sending email disclaimers and legalese if possible as this is a
+public list. However, we are aware that many corporate users are unable
+to avoid this.
+
+@item
+Avoid using the @code{-loglevel debug}, @code{-loglevel quiet}, and
+@command{-hide_banner} options unless requested to do so.
+
+@item
+If you attach files avoid compressing small files. Uncompressed is
+preferred.
+@end itemize
+
+@chapter Help
+
+@section Who do I contact if I have a problem with the mailing list?
+
+Send a message to @email{ffmpeg-user-owner@@ffmpeg.org}.
+
+@bye
--
2.14.1
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
http://ffmpeg.org/mailman/listinfo/ffmpeg-devel
