[MPlayer-dev-eng] [PATCH] Misc. docs changes
Andras Mohari
mayday at varoshaza.nagyatad.hu
Thu Aug 15 11:42:42 CEST 2002
Hi,
Here's another DOCS patch:
* I've put some important warnings and notes in BLOCKQUOTEs (they have
"titles" in bold, so they stand out clearly, IMHO).
* In the first paragraph of "How to read this documentation": removed
"TOC", made "FAQ" a link and fixed a spelling error.
* Put quote from Chris Phillips inside a BLOCKQUOTE.
* Put "HINT: Press the middle button ..." inside a BLOCKQUOTE with "Hint"
as a bold face title.
* Emphasized a sentence (but haven't restored "!").
* Lowercased some words (but emphasized them!).
--
Andras Mohari
mayday at mail.nagyatad.hu
-------------- next part --------------
diff -Naur DOCS.old/codecs.html DOCS/codecs.html
--- DOCS.old/codecs.html Wed Aug 14 14:21:02 2002
+++ DOCS/codecs.html Thu Aug 15 10:35:35 2002
@@ -15,8 +15,10 @@
<P><B><A NAME="video_codecs">2.2.1 Video codecs</A></B></P>
+<BLOCKQUOTE><B>Note</B>
<P>See the <A HREF="http://www.mplayerhq.hu/DOCS/codecs-status.html">codec status table</A>
for the complete, daily generated list.</P>
+</BLOCKQUOTE>
<P>The most important ones above all:</P>
<UL>
diff -Naur DOCS.old/documentation.html DOCS/documentation.html
--- DOCS.old/documentation.html Wed Aug 14 14:21:06 2002
+++ DOCS/documentation.html Thu Aug 15 11:15:07 2002
@@ -307,8 +307,9 @@
<P>If you are a first-time installer: be sure to read everything from here to
the end of the Installation section, and follow the links you will find. If
- you have any other questions, return to the TOC (Table of Contents) and
- search for the topic, read the FAQ, or try grepping though the files.</P>
+ you have any other questions, return to the Table of Contents and
+ search for the topic, read the <A HREF="faq.html">FAQ</A>, or try grepping
+ through the files.</P>
<P>The main rule of this documentation: if it's not documented, it
<U>does not exist</U>. If I don't say you encode audio from TV tuner, you
@@ -316,7 +317,7 @@
Good luck. You'll need it :) And for another good advice, let me quote
Chris Phillips from the <B>mplayer-users</B> mailing list:</P>
-<P><I>"I said a while ago that there is such a difference between a newbie and
+<BLOCKQUOTE>I said a while ago that there is such a difference between a newbie and
a dumbass. No matter what you actually know about a system (linux, cars,
girls :D) you should ALWAYS be able to take a step back and be objective,
otherwise, you're just dumb IMHO. A girl i live with assumed the vacuum
@@ -325,7 +326,7 @@
case of simply not knowing what to do... Simply not being that familiar with
your surroundings is no excuse for a) laziness and b) ignorance. So many
people seem to see the word "error" and then stop... few seem to actually
- read the words on the OTHER side of the colon."</I></P>
+ read the words on the OTHER side of the colon.</BLOCKQUOTE>
@@ -560,9 +561,9 @@
<A HREF="video.html#tdfxfb">tdfxfb</A> section in order to gain big
speedup. It is important to do these steps <I>before</I> compiling
<B>MPlayer</B>, otherwise no 3Dfx support will be built. Also see the <A
- HREF="video.html#tv-out_voodoo">3dfx TV-out section</A>. If you use X, use at
+ HREF="video.html#tv-out_voodoo">3dfx TV-out section</A>. <B>If you use X, use at
least 4.2.0, as 3dfx Xv driver was broken in 4.1.0, and earlier
- releases.</LI>
+ releases.</B></LI>
<LI><B>ATI cards</B>: <A HREF="video.html#vidix">Vidix driver</A> is
provided for the following cards:
<B>Radeon</B>, <B>Rage128</B>, <B>Mach64</B> (Rage XL/Mobility, Xpert98).
@@ -732,8 +733,10 @@
and call <CODE>gmplayer</CODE> instead.</LI>
</UL>
-<P>HINT: Press the middle button (on 2 button mice press left and right
+<BLOCKQUOTE><B>Hint</B>
+ <P>Press the middle button (on 2 button mice press left and right
simultaneously) to open a GTK menu with DVD playing option!</P>
+</BLOCKQUOTE>
<P>As <B>MPlayer</B> doesn't have a skin included, you have to download them if
you want to use the GUI. See the
@@ -1844,8 +1847,10 @@
<P><B><A NAME="authors">Appendix A - Authors</A></B></P>
-<P>NOTE: Do <B>not</B> send bug reports, help & feature requests directly to
+<BLOCKQUOTE><B>Important</B>
+ <P>Do <B>not</B> send bug reports, help & feature requests directly to
the authors!</P>
+</BLOCKQUOTE>
<P>Read <A HREF="bugreports.html">Appendix C</A> and subscribe to mplayer-users mailing lists.</P>
diff -Naur DOCS.old/faq.html DOCS/faq.html
--- DOCS.old/faq.html Thu Aug 15 10:18:41 2002
+++ DOCS/faq.html Thu Aug 15 11:31:14 2002
@@ -547,15 +547,15 @@
<DD>A: It works only if running as root! It's a DGA limitation.
You should become root (<CODE>su -</CODE>), and try again.
Another solution is making <B>MPlayer</B> SUID root, but it's
- <B>NOT RECOMMENDED!</B><BR>
+ <B>not recommended!</B><BR>
<CODE>chown root /usr/local/bin/mplayer</CODE><BR>
<CODE>chmod 755 /usr/local/bin/mplayer</CODE><BR>
<CODE>chmod +s /usr/local/bin/mplayer</CODE><BR>
- <B>!!!! BUT STAY TUNED !!!!</B><BR>
- This is a *BIG* security risk! *NEVER* do this on a server or on a computer
+ <BLOCKQUOTE><B>Warning: security risk</B><P>
+ This is a <B>big</B> security risk! <B>Never</B> do this on a server or on a computer
that you do not control completely because other users can gain root
- privileges through SUID root MPlayer!!!<BR>
- <B>!!!! SO YOU HAVE BEEN WARNED ... !!!!</B></DD>
+ privileges through SUID root <B>MPlayer</B>.
+ <B>You have been warned.</B></P></BLOCKQUOTE></DD>
<DD> </DD>
<DT>Q: When using Xvideo, my Voodoo 3/Banshee says:<BR>
diff -Naur DOCS.old/video.html DOCS/video.html
--- DOCS.old/video.html Wed Aug 14 14:21:12 2002
+++ DOCS/video.html Thu Aug 15 11:31:03 2002
@@ -230,8 +230,8 @@
Technically spoken this happens by mapping the framebuffer memory into
the memory range of your process. This is allowed by the kernel only
if you have superuser privileges. You can get these either by logging in
- as root or by setting the SUID bit on the <B>MPlayer</B> executable (NOT
- recommended!).</P>
+ as root or by setting the SUID bit on the <B>MPlayer</B> executable (<B>not
+ recommended</B>).</P>
<P>There are two versions of DGA: DGA1 is used by XFree 3.x.x and DGA2 was
introduced with XFree 4.0.1.</P>
@@ -275,11 +275,12 @@
<P>Now it works as a simple user, too.</P>
-<P><B>!!!! BUT STAY TUNED !!!!</B><BR>
- This is a <B>BIG</B> security risk! Never do this on a server or on a
- computer can be accessed by more people than only you because they can gain
- root privileges through SUID root <B>MPlayer</B>.<BR>
- <B>!!!! SO YOU HAVE BEEN WARNED ... !!!!</B></P>
+<BLOCKQUOTE><B>Warning: security risk</B><P>
+ This is a <B>big</B> security risk! <B>Never</B> do this on a server or on a
+ computer that can be accessed by other people because they can gain
+ root privileges through SUID root <B>MPlayer</B>.
+ <B>You have been warned.</B></P>
+</BLOCKQUOTE>
<P>Now use the <CODE>-vo dga</CODE> option, and there you go (hope so :))!
You should also try if the <CODE>-vo sdl:dga</CODE> option works for you. It's
@@ -902,9 +903,11 @@
it (mainly libdha). But there is hope that it will work on those systems
where X11 does.</P>
-<P>And the last <B>WARNING</B>: (un)fortunately you <B>MUST</B> have
- <B>ROOT</B> privileges to use VIDIX due to direct hardware access. At least
+<BLOCKQUOTE><B>Warning</B>
+ <P>(Un)fortunately you <B>must</B> have
+ <B>root</B> privileges to use VIDIX due to direct hardware access. At least
set the <B>SUID</B> bit on the <B>MPlayer</B> executable.</P>
+</BLOCKQUOTE>
<P><B>VIDEO EQUALIZER</B></P>
More information about the MPlayer-dev-eng
mailing list