Initial revision

CVS patchset: 1
CVS date: 2001/04/18 22:33:39

5 files changed, 404 insertions, 0 deletions

diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
new file mode 100644
index 000000000..de46beca4
--- /dev/null
+++ b/doc/man/Makefile.am
@@ -0,0 +1,9 @@
+SUBDIRS = fr en
+
+mostlyclean-generic:
+	-rm -f *~ \#* .*~ .\#*
+
+maintainer-clean-generic:
+	-@echo "This command is intended for maintainers to use;"
+	-@echo "it deletes files that may require special tools to rebuild."
+	-rm -f Makefile.in
diff --git a/doc/man/en/Makefile.am b/doc/man/en/Makefile.am
new file mode 100644
index 000000000..b70881881
--- /dev/null
+++ b/doc/man/en/Makefile.am
@@ -0,0 +1,11 @@
+man_MANS = xine.1
+
+EXTRA_DIST = $(man_MANS) xine.1.in
+
+mostlyclean-generic:
+	-rm -f *~ \#* .*~ .\#*
+
+maintainer-clean-generic:
+	-@echo "This command is intended for maintainers to use;"
+	-@echo "it deletes files that may require special tools to rebuild."
+	-rm -f Makefile.in xine.1
diff --git a/doc/man/en/xine.1.in b/doc/man/en/xine.1.in
new file mode 100644
index 000000000..2739c44c0
--- /dev/null
+++ b/doc/man/en/xine.1.in
@@ -0,0 +1,173 @@
+.\" -*-Nroff-*-
+.\""
+.TH XINE 1x 2000-11-19 "The xine project"
+.\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
+.\" other parms are allowed: see man(7), man(1)
+.\""
+.SH NAME
+xine \- MPEG2/MPEG1 audio/video player
+.SH SYNOPSIS
+.B xine
+.I "[options] [MRL] ..."
+.SH "DESCRIPTION"
+This manual page documents briefly the
+.BR xine
+audio/video player.
+.PP
+.B xine
+plays MPEG system streams, synchronizing audio and video substreams. It
+can play streams from files, Video CDs, DVDs and other sources.
+.SH OPTIONS
+The programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options are included below.
+For a complete description, see the README and FAQ in @prefix@/share/doc/xine
+or on the xine home page.
+.TP
+.B \-h, \-\-help
+Show summary of options.
+.TP
+.B \-s, \-\-shared\-memory
+Use X shared memory extension for output.
+.br
+This may be useful if you experience
+problems using the Xv extension. Xv is used as default, if it is available.
+Since Xv is hardware accelerated, it usually provides more features and
+better performance.
+.TP
+.B \-a, \-\-audio\-channel <num>
+Select the given audio channel. <num> is the audio channel number, default
+is "0".
+.br
+For MPEG2-Streams, AC3 audio streams are numbered from 0 to 7, while MPEG
+audio streams are numbered from 8 to 15 and lpcm audio streams are
+numbered 16 to 23 (provided that there are this many audio substreams, 
+of course). Finding the right audio stream might needs some experimenting,
+as some mp2-streams contain audio in strange tracks (track 0 and 1 may
+be empty but track 2 contains valid audio, for example).
+.TP
+.B \-A, \-\-audio\-driver <drv>
+Select audio driver. Valid drivers are "oss", "alsa", "esd" or "null". The
+default is to use ESD when the "ESPEAKER" environment variable is set,
+otherwise ALSA if present, otherwise OSS. The "null" driver may be used to
+disable audio output, eg. if there are problems with your sound card.
+.TP
+.B \-u, \-\-spu\-channel <num>
+Select subpicture (subtitle) channel. <num> is the subpicture channel
+id, default is no subtitle (-1).
+.TP
+.B \-S, \-\-spdif
+Enable AC3 output via SPDIF. Works only on some ALSA drivers that support
+the AC3 passthrough feature.
+.TP
+.B \-p[f][h][q][d][v]
+Start playing immediately after start. Can be followed by "f" to turn
+on fullscreen mode and/or "h" to hide GUI, and/or by "q" for quitting 
+at the end. It is also possible to request the playlist from DVD 'd',
+or VCD 'v'.
+.TP
+.B MRL (media resource locator)
+.br
+MRLs are similar to URLs in your web browser. They describe the media
+to read from. valid MRLs may be plain file names or one of the following:
+.BR file://<path>
+.br
+.BR fifo://<path>
+.br
+.BR stdin://mpeg1
+or
+.BR "stdin://mpeg2"
+.br
+.BR dvd://VTS_xx_y.VOB
+.br
+.BR "vcd://<track number>"
+.br
+.BR "net://???"
+.LP
+Several MRLs may be specified in order to play a number of consecutive
+streams.
+.LP
+If you don't specify any MRL, you'll have to select  a file by drag'n-drop.
+Dragging files from the GNOME Midnight Commander (gmc) is known to work.
+.SH "SEE ALSO"
+The programs are documented fully on the xine home page:
+.IR "http://xine.sourceforge.net/"
+.SH CONTROL KEYS
+Many features can be controlled by pressing control keys. The Key bindings are:
+.LP
+.BR RETURN :
+Play
+.br
+.BR SPACE
+or
+.BR P :
+Pause
+.br
+.BR F :
+Toggle fullscreen mode (Xv only)
+.br
+.BR G :
+Hide/show the gui.
+.br
+.BR H :
+Hide/show the video output window.
+.br
+.BR A :
+Toggle aspect ratio (AUTO/16:9/4:3/DVB) 
+.br
+.BR C :
+Show/hide the video settings window.
+.br
+.BR E :
+Eject the current media.
+.br
+.BR 0 :
+Jump to start of current stream
+.br
+.BR 1..9 :
+Jump to 10%..90% of current stream
+.br
+.BR PgUp :
+Jump to previous stream in playlist
+.br
+.BR PgDown :
+Jump to next stream in playlist
+.br
+.BR + :
+Select next audio channel (may take up to a few seconds to take effect)
+.br
+.BR - :
+Select prev audio channel
+.br
+.BR Ctrl
+Show/hide mouse cursor (only when the GUI is hide)
+.br
+.BR >
+or
+.BR . :
+Select next sub-title channel.
+.br
+.BR <
+or
+.BR , :
+Select previous sub-title channel.
+.br
+.SH Synchronization fine tuning
+Some streams have bad timestamps, so synchronization fails. This can be
+tweaked using arrow keys:
+.br
+.BR Left :
+press if video runs ahead of audio
+.br
+.BR Right :
+press if video lags behind audio
+.br
+.BR Home :
+press to reset audio/video offset to 0, so stream timestamps are unchanged.
+
+.SH AUTHOR
+This manual page was written by Siggi Langauf <siggi@debian.org>,
+for the xine project. Lots of additions by
+Guenter Bartsch <guenter@users.sourceforge.net> and
+Daniel Caujolle-Bert <f1rmb@users.sourceforge.net>
+
diff --git a/doc/man/fr/Makefile.am b/doc/man/fr/Makefile.am
new file mode 100644
index 000000000..0335fd786
--- /dev/null
+++ b/doc/man/fr/Makefile.am
@@ -0,0 +1,46 @@
+mansubdir=/fr/man1
+
+man_MANS = xine.1
+
+EXTRA_DIST = $(man_MANS) xine.1.in
+
+install-man1:
+	$(mkinstalldirs) $(DESTDIR)$(mandir)$(mansubdir)
+	@list='$(man1_MANS)'; \
+	l2='$(man_MANS)'; for i in $$l2; do \
+	  case "$$i" in \
+	    *.1*) list="$$list $$i" ;; \
+	  esac; \
+	done; \
+	for i in $$list; do \
+	  if test -f $(srcdir)/$$i; then file=$(srcdir)/$$i; \
+	  else file=$$i; fi; \
+	  ext=`echo $$i | sed -e 's/^.*\\.//'`; \
+	  inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \
+	  inst=`echo $$inst | sed '$(transform)'`.$$ext; \
+	  echo " $(INSTALL_DATA) $$file $(DESTDIR)$(mandir)$(mansubdir)/$$inst"; \
+	  $(INSTALL_DATA) $$file $(DESTDIR)$(mandir)$(mansubdir)/$$inst; \
+	done
+
+uninstall-man1:
+	@list='$(man1_MANS)'; \
+	l2='$(man_MANS)'; for i in $$l2; do \
+	  case "$$i" in \
+	    *.1*) list="$$list $$i" ;; \
+	  esac; \
+	done; \
+	for i in $$list; do \
+	  ext=`echo $$i | sed -e 's/^.*\\.//'`; \
+	  inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \
+	  inst=`echo $$inst | sed '$(transform)'`.$$ext; \
+	  echo " rm -f $(DESTDIR)$(mandir)$(mansubdir)/$$inst"; \
+	  rm -f $(DESTDIR)$(mandir)$(mansubdir)/$$inst; \
+	done
+
+mostlyclean-generic:
+	-rm -f *~ \#* .*~ .\#*
+
+maintainer-clean-generic:
+	-@echo "This command is intended for maintainers to use;"
+	-@echo "it deletes files that may require special tools to rebuild."
+	-rm -f Makefile.in xine.1
diff --git a/doc/man/fr/xine.1.in b/doc/man/fr/xine.1.in
new file mode 100644
index 000000000..708880d67
--- /dev/null
+++ b/doc/man/fr/xine.1.in
@@ -0,0 +1,165 @@
+.\" -*-Nroff-*-
+.\""
+.TH XINE 1x 2000-11-19 "Le projet xine"
+.SH NOM
+xine \- Lecteur audio/vidéo MPEG2/MPEG1.
+.SH SYNOPSIS
+.B xine
+.I "[options] [MRL] ..."
+.SH DESCRIPTION
+Cette page de manuel documente brièvement le lecteur audio/vidéo \fBxine\fP.
+.PP
+\fBxine\fP lis les flux système MPEG, synchronise les flux audio et vidèo.
+Il peux lire les flux a partir de fichiers, CD Vidéo, DVD et d'autres sources.
+.SH OPTIONS
+Ce programme suis la syntaxe de ligne de commande GNU, avec les longues
+options commençant par deux tirets ('-').
+Une list de ces options est incluse plus bas.
+Pour une description complète, lisez les fichiers README et FAQ 
+dans @prefix@/share/doc/xine ou sur la homepage.
+.TP
+.B \-h, \-\-help
+Affiche la liste des options.
+.TP
+.B \-s, \-\-shared\-memory
+utilise l'extension 'X Shared Memory' pour la sortie.
+.br
+Cela peut être utile si vous rencontrez des problèmes en utilisant
+l'extension 'Xv', Xv est utilisée par defaut, si elle est disponible.
+Comme Xv est accélérée materiellement, elle offre plus de fonctionnalitées
+et de meilleurs performances.
+.TP
+.B \-a, \-\-audio\-channel <num>
+Sélectionne le canal audio spécifié. <num> est le numéro du canal, la valeur
+par defaut est '0'.
+.br
+Pour les flux MPEG2, les flux audio AC3 sont numérotés de 0 à 7, tandis 
+que les flux MPEG sont numérotés de 8 à 39 (si il y a plusieurs sous 
+flux audio, bien entendu)
+.TP
+.B \-A, \-\-audio\-driver <drv>
+Sélectionne le pilote audio. Les pilotes valides sont "oss" (defaut), 
+"alsa", "esd" ou "null".
+Par defaut ESD est utilisé si la variable d'environnement "ESPEAKER"
+est positionnée, sinon ALSA si présent, ou alors OSS. Le pilote "null" 
+peut être utilisé pour supprimer la sortie audio, par exemple, si il y 
+a des problemes avec la carte son.
+.TP
+.B \-u, \-\-spu\-channel <num>
+Sélectionne le canal de subpicture (sous-titres). <num> est le numéro
+du canal de subpicture, par défaut il n'y a pas de sous-titre (\-1)
+.TP
+.B \-S, \-\-spdif
+Met en fonction la sortie AC3 via SPDIF. Ne fonctionne qu'avec
+certains pilotes ALSA supportant la fonctionnalité AC3 taversante.
+.TP
+.B \-p[f][h][q][d][v], 
+Démarre la lecture immédiatement apres l'execution. Peut être suivi
+par 'f' pour passer en mode plein écran, et/ou par 'h' pour
+masquer le panneau de contrôle, et/ou par 'q' pour quitter
+à la fin de la lecture. Il est possible d'obtenir automatiquement
+les listes de lecture à partir d'un DVD 'd', ou d'un VCD 'v'.
+.TP
+.B MRL (media resource locator)
+.br
+Les MRLs sont similaires aux URLs de votre navigateur internet. Elles
+définissent le média à utiliser comme source de lecture.
+Les MRLs valides peuvent être les noms de fichiers ou un de ceux qui suis:
+.br
+.BR file://<chemin>
+.br
+.BR fifo://<chemin>
+.br
+.BR stdin://mpeg1
+or
+.BR "stdin://mpeg2"
+.br
+.BR dvd://VTS_xx_y.VOB
+.br
+.BR "vcd://<numéro piste>"
+.br
+.BR "net://???"
+.LP
+Plusieurs MRLs peuvent être spécifiées pour lire un nombre consecutif
+de flux.
+.LP
+Si vous ne spécifiez aucune MRL, vous pourrez sélectionner un fichier
+par glisser-lacher.
+Glisser des fichiers depuis GNOME Midnight Commander (gmc) est connu
+pour fonctionner.
+.SH "VOIR AUSSI"
+Le programme est complement documenté sur la homepage de xine:
+.IR "http://xine.sourceforge.net/"
+.SH TOUCHES DE CONTROLE
+Beaucoup de fonctions peuvent êtres contrôlées en pressant certaines touches.
+La liste de ces touches sont:
+.LP
+.BR ENTREE :
+Lecture
+.br
+.BR ESPACE
+ou 
+.BR P :
+Pause
+.br
+.BR F :
+Bascule plein écran (Xv seulement).
+.br
+.BR G :
+Affiche/masque le panneau de contrôle.
+.br
+.BR H :
+Affiche/masque la fenêtre de sortie.
+.br
+.BR A :
+Bascule du ratio d'aspect (AUTO/16:9/4:3/DVB) 
+.br
+.BR C :
+Affiche/masque la fenêtre des réglages vidéo.
+.br
+.BR E :
+Ejecte le média courant.
+.br
+.BR 0 :
+Saute au début du flux courant.
+.br
+.BR 1..9 :
+Saute à 10%..90% du flux courant.
+.br
+.BR PgUp :
+Saute au flux precédent dans la liste de lecture.
+.br
+.BR PgDown :
+Saute au flux suivant dans la liste de lecture.
+.br
+.BR + :
+Sélectionne le canal audio suivant (peux prendre quelques secondes
+avant effet).
+.br
+.BR - :
+Sélectionne le canal audio precédent.
+.br
+.BR Ctrl
+Affiche/masque le pointeur de souris (uniquement quand le panneau de
+contrôle est masqué).
+.br
+.BR >
+ou
+.BR . :
+Sélectionne le canal de sous-titres suivant.
+.br
+.BR <
+ou
+.BR , :
+Sélectionne le canal de sous-titres precédant.
+.br
+.BR Gauche :
+Change négativement la synchronisation A/V.
+.br
+.BR Droit :
+Change positivement la synchronisation A/V.
+.br
+.BR Début :
+Remise à zéro de la synchronisation A/V.
+.SH AUTEURS
+Cette page de manuel a été écrite par Siggi Langauf <siggi@users.sourceforge.net>, traduite par Daniel Caujolle-Bert <f1rmb@users.sourceforge.net>, pour le projet xine.