reorganized, reformatted, explanation improved, typos, wording

git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@12876 b3059339-0415-0410-9bf9-f77b7e298cf2

1 files changed, 96 insertions, 70 deletions

diff --git a/etc/example.conf b/etc/example.conf
index a235c1c271..263b1e2fc3 100644
--- a/etc/example.conf
+++ b/etc/example.conf
@@ -1,61 +1,69 @@
 ##
-## MPlayer config file
+## MPlayer configuration file
 ##
-## This file can be copied to /usr/local/etc/mplayer.conf and/or ~/.mplayer/config .
-## If both exist, the ~/.mplayer/config's settings override the
-## /usr/local/etc/mplayer.conf ones. And, of course command line overrides all.
-## The options are the same as in the command line, but they can be specified
-## more flexibly here. See below.
+## Configuration files are read system-wide from /usr/local/etc/mplayer.conf
+## and per user from ~/.mplayer/config, where per-user settings override
+## system-wide settings, all of which are overrriden by the command line.
 ##
+## The options are the same as on the command line.
+##
+
+
+##
+## video settings
+##
+
+# Specify default video driver (see -vo help for a list).
+# vo=xv
 
-# vo=xv			# To specify default video driver (see -vo help for
-			# list)
+# Specify default audio driver (see -ao help for a list).
+# ao=oss
 
-# ao=oss		# To specify default audio driver (see -ao help for
-			# list)
+# fullscreen mode
+# fs=yes
 
-fs=yes			# Enlarges movie window to your desktop's size.
-			# Used by drivers: all
+# Change to a different videomode when going fullscreen
+# (dga, x11, sdl video output drivers only).
+# vm=no
 
-# vm=no			# Tries to change to a different videomode
-			# Used by drivers: dga2, x11, sdl
+# Force changing display depth (valid settings are: 0, 15, 16, 24, 32).
+# May need 'vm=yes' as well, only works with fbdev, dga, svga, vesa
+# video output drivers.
+# bpp=0
 
-# bpp=0			# Force changing display depth.
-			# Valid settings are: 0, 15, 16, 24, 32
-			# may need 'vm=yes' too.
-			# Used by drivers: fbdev, dga2, svga, vesa
+# Enable software scaling (powerful CPU needed).
+# Some video output drivers (svga, x11, vesa) do not support hardware scaling.
+# zoom=no
 
-# zoom=no		# Enable software scaling (powerful CPU needed)
-			# Used by drivers: svga, x11, vesa
+# Doublebuffering can help remove flicker from subtitles/OSD.
+# double=yes
 
-# double=yes		# use double-buffering (recommended for xv with
-			# SUB/OSD usage)
+# standard monitor size, with square pixels
+# monitoraspect=4:3
 
-# monitoraspect=4:3	# standard monitor size, with square pixels
-# monitoraspect=16:9	# use this for widescreen monitor! non-square pixels
+# Use this for a widescreen monitor, non-square pixels.
+# monitoraspect=16:9
 
-# ontop=yes		# Makes the player window stay ontop
-			# Used by drivers which use X11, except SDL,
-			# as well as directx and gl2 under Windows
+# Makes the player window stay on top of all other windows.
+# ontop=yes
 
 ##
 ## Specify your preferred default skin here
 ## (skins are searched in /usr/local/share/mplayer/Skin/yourskin
 ##  and ~/.mplayer/Skin/yourskin)
 ##
-
 # skin = default
 
 ##
 ## Multiple languages are available :)
 ##
 ## Hungarian	igen	nem
-## English	yes	no
-## German	ja	nein
-## Spanish	si	no
-## Polish	tak	nie
-## Swedish ja nej
-## Binary	1	0
+## English		yes		no
+## German		ja		nein
+## Spanish		si		no
+## Polish		tak		nie
+## Swedish		ja		nej
+## Binary		1		0
 ##
 ## You can also use spaces and/or tabs.
 ##
@@ -71,68 +79,86 @@ fs=yes			# Enlarges movie window to your desktop's size.
 ## 1	narrow black outline
 ## 10	bold black outline
 ##
-
 # ffactor = 0.75
 
 ##
-## FBdev driver: 
-
-# fb = /dev/fb0				# framebuffer device to use
-# fbmode = 640x480-120			# use this mode (read from fb.modes!)
-# fbmodeconfig = /etc/fb.modes		# the fb.modes file
+## FBdev driver:
+##
+# framebuffer device to use
+# fb = /dev/fb0
+#
+# mode to use (read from fb.modes)
+# fbmode = 640x480-120
+#
+# location of the fb.modes file
+# fbmodeconfig = /etc/fb.modes
 
-## VESA and FBdev driver: specify your monitor's timings
-## 
-## (see for example /etc/X11/XF86Config for timings!)
+## VESA and FBdev driver: Specify your monitor's timings.
+##
+## (see /etc/X11/XF86Config for timings)
 ## ** CAUTION! IF YOUR DISPLAY DOESN'T SUPPORT AUTOMATICALLY TURNING OFF WHEN
 ##    OVERDRIVED (AND EVEN IF IT DOES), THIS MAY CAUSE DAMAGE TO YOUR DISPLAY!
 ##    WE AREN'T RESPONSIBLE, IT'S YOUR DECISION! **
 ##
-## k, K : means multiply by 1000
-## m, M : means multiply by 1.000.000
+## k, K: means multiply by 1000
+## m, M: means multiply by 1.000.000
 ##
-# monitor-hfreq = 31.5k-50k,70k		# horizontal frequency range
-# monitor-vfreq = 50-90			# vertical frequency range
-# monitor-dotclock = 30M-300M		# dotclock (or pixelclock) range
+# horizontal frequency range
+# monitor-hfreq = 31.5k-50k,70k
+#
+# vertical frequency range
+# monitor-vfreq = 50-90
+#
+# dotclock (or pixelclock) range
+# monitor-dotclock = 30M-300M
 
 ##
 ## SDL driver
 ##
-
-# vo = sdl:aalib	# use SDL video driver by default
-			# use "vo = sdl:aalib" or "vo sdl:dga" and so on,
-			# for specifying SDL subdrivers
-# ao = sdl:esd		# use SDL audio driver by default
-			# use "ao = sdl:esd" to use SDL's ESD driver
-# noxv = no		# whether to use XVideo hardware acceleration or not
-# forcexv = yes		# force XVideo even if not detected
+# Use SDL video with the aalib subdriver by default.
+# vo = sdl:aalib
+#
+# Use SDL audio driver with the esd subdriver by default.
+# ao = sdl:esd
+#
+# Turn off XVideo hardware acceleration.
+# noxv = no
+#
+# Force XVideo even if not detected.
+# forcexv = yes
 
 
 ##
 ## Other (preferred to be default from configfile) switches
 ##
+# Drop frames to preserve audio/video sync.
+framedrop 	= yes
 
-framedrop 	= yes	# drop frames, when not in sync (slow CPU, videocard,
-			# etc)
+##
+## cache settings
+##
+# Use 8MB input cache by default.
+cache	        = 8192
+#
+# Prefill 20% of the cache before starting playback.
+cache_min	    = 20.0
+#
+# Prefill 5% of the cache before restarting playback after the cache emptied.
+cache_prefill	= 5.0
 
-cache		= 8192	# use 8Mb input cache by default
-cache_min	= 20.0  # Prefill 20% of the cache before initially playing
-cache_prefill	= 5.0   # Prefill 5% of the cache before restarting playback if it empties
+# DVD: Display English subtitles if available.
+# slang		= en
 
-# slang		= en	# DVD : display english subtitles if available
-# alang		= en	# DVD : play english audio tracks if available
+# DVD: Play English audio tracks if available.
+# alang		= en
 
 
 ## This is the correct way to use "subconfig" type options in the
-## configuration file. In the command line you use :
-## -aop list=resample:fout=44100 , but here it is :
+## configuration file. In the command line you use:
+## -aop list=resample:fout=44100 , but here it is:
 # aop=list=resample:fout=44100
 
 ##
 ## You can also include other configfiles
-## Specify full path!
 ##
-## Delete this default :)
-##
-
-include = /home/gabucino/.mplayer/i_did_not_RTFM_carefully_enough...
+#include = /path/to/the/file/you/want/to/include