--- emms/emms.texinfo 2004-07-11 04:51:47.000000000 +0300 +++ emms-04072005-CVS/emms.texinfo 2005-07-04 13:21:47.560667032 +0300 @@ -1,7 +1,7 @@ \input texinfo @c -*-texinfo-*- @c %**start of header @setfilename emms.info -@settitle Emms Manual 0.1 +@settitle EMMS Manual 0.1 @c %**end of header @c This is the beginning of the Emms Manual. I just bring the README @@ -26,9 +26,9 @@ * The core file: emms. The inner core of EMMS * Sources: emms-sources. Sources for playlists-creation * Simple Player: emms-players. Some simple players -* Info tags: emms-info. Mure narrative track descriptions +* Info tags: emms-info. More narrative track descriptions * Playlist manipulation: emms-manip. Some playlist manipulation functions -* Playlist Buffer: emms-pbi. Brwosing buffer known by other players +* Playlist Buffer: emms-pbi. Browsing buffer known by other players * Playlist Popup: emms-pbi-popup. Popup the playlist buffer. * Scoring: emms-score. Play files based on their rating * Extension: emms-extensions. How to define new players and modules @@ -44,7 +44,7 @@ EMMS is the Emacs Multi-Media System. It tries to be a clean and small application to play multimedia files from Emacs using external -players. Many of it's ideas are derived from MpthreePlayer +players. Many of its ideas are derived from MpthreePlayer (http://www.nongnu.org/mp3player), but it tries to be more general and more clean. @@ -65,7 +65,7 @@ to play them. emms-player-simple.el defines a few useful players, and allows you to define your own in a very simple way. -EMMS is easy to customize by using some modules shipped with +EMMS is easy to customise by using the modules shipped with emms. @xref{emms-extensions}. @node installation @@ -84,25 +84,51 @@ @chapter Quickstart EMMS is quite simple to set up. For the most basic needs, you will -just need the following lines: +just need the following line: @lisp (require 'emms) -(require 'emms-player-simple) -(require 'emms-source-file) -(setq emms-player-list '(emms-player-mpg321 - emms-player-ogg123 - emms-player-mplayer) - emms-source-list '((emms-source-directory-tree "~/media/"))) @end lisp -@noindent -Assuming that your files reside in "~/media/". Adjust as needed. +Which installs the core of EMMS. Now we need to do some configuration. + +The EMMS module `emms-default' provides the function `emms-setup', +which is a way to quickly configure your EMMS. You can add any number +of directories which contain media. The first argument is the +complexity level of the user interface. Here's an example: + +@lisp +(require 'emms-default) +(emms-setup 'tiny "directory-1" "directory 2" ...) +@end lisp + +Here is a list of the interface complexity options: + +@table @samp +@item minimalistic +Define the players and play directory but nothing more. +@item tiny +Features the pbi (playlist buffer interface). +@item default +Features info reading for MP3 and OGG files. +@item advanced +Features the tageditor and playlist manipulation. +@item cvs +Features playlist pop-up, pbi marking, mode-line, asynchronous loading +of tags and (of course) the kitchen sink. +@end table + +The directories you gave to `emms-setup' are used by the +`emms-play-all' function, in case you are wondering. + +Now your configuration is done. + +@chapter Configuration examples -We're providing some example configuration, so you can see how you -can customize EMMS. +Here we provide some example configurations, so you can see how EMMS +can be customised. -The following code is a customiazion by Jorgen Schäfer: +The following code is a customisation by Jorgen Schäfer: @lisp (global-set-key (kbd "ESC O c") 'emms-next) @@ -145,7 +171,7 @@ @end lisp @noindent -The next example is coming from Ulrik Jensen: +The next example is from Ulrik Jensen: @lisp (add-to-list 'load-path "~/elisp/emms-lukhas/emms/") @@ -184,7 +210,7 @@ @chapter Basic commands for playing music Before you can use the interface commands, you need a playlist to -start with. The following commands allow you to create a or add to the +start with. The following commands allow you to create or add to the current playlist from different sources: @defun emms-play-file @@ -215,10 +241,11 @@ Play every source in emms-source-list @end defun -The basic functionality of EMMS ist just to play music without being +The basic functionality of EMMS is just to play music without being noticed. It provides a few commands to skip the current track and -such, but else, it doesn't show up. EMMS provides the following basic -user commands (that you might want to bind to keys): +such, but other than that it doesn't show up. EMMS provides the +following basic user commands (which you might want to bind to +keystrokes): @defun emms-start Start playing the current playlist @@ -523,11 +550,11 @@ @defmac define-emms-simple-player Returns a simple player with the use of emms-define-player. -NAME is used to contruct the name of the function like +NAME is used to construct the name of the function like emms-player-NAME. REGEX must be a regexp that matches the filenames the player can play. COMMAND specifies the command line -arguement to call the player and ARGS are the command line -arguements. +argument to call the player and ARGS are the command line +arguments. @end defmac @defun emms-player-simple-stop @@ -542,7 +569,7 @@ @end defun @node emms-info -@chapter Getting infos from your media tracks +@chapter Getting info from your media tracks The file @file{emms-info.el} provides an interface for different methods of reading info about the files that EMMS is playing, and displaying it. @@ -628,7 +655,7 @@ @end lisp @noindent -You'll ofcourse need to also have a player if you want to actually +You'll of-course need to also have a player if you want to actually play the files. @defun emms-info-ogg-comment-providep @@ -637,11 +664,11 @@ @defun emms-info-ogg-get-comment @end defun @defun emms-info-ogg-comment-get -Retrieve an emms-info strucutre as an ogg-comment +Retrieve an emms-info structure as an ogg-comment @end defun @node emms-mp3 -@section Retriebing mp3 tags +@section Retrieving mp3 tags This code has been adapted from code found in mp3player.el, written by Jean-Philippe Theberge @email{jphiltheberge@@videotron.ca}, Mario Domgoergen @@ -656,7 +683,7 @@ @end lisp @noindent -You'll ofcourse need to also have a player if you want to actually +You'll of-course need to also have a player if you want to actually play the files. @defun emms-info-mp3info-providep @@ -785,7 +812,7 @@ there was already a emacs mode that does exactly the same: setnu.el So we remove the linenumbering functions in favour of setnu. You can get setnu from @url{http://www.wonderworks.com/download/setnu.el}. To get -linenumbers just put the following code in your @file{~/.emacs} and put +line numbers just put the following code in your @file{~/.emacs} and put setnu.el somewhere on your loadpath: @lisp @@ -920,14 +947,14 @@ When you load @file{emms-score}, you are set to a default mood 'emms-default-mood' A mood is a one word string describing how you feel (like "funny", -"tired", "aggresive"...) Each mood have is own set of scoring rules. +"tired", "aggressive"...) Each mood have is own set of scoring rules. You can change your mood with M-x @command{emms-score-change-mood} Every music file start with a default score of 0 the command emms-score-up-current and emms-score-down-current modify the score of -the file you are curently listening by 1 In addition, skipping a file -(with emms-skip) automaticaly score the file down. +the file you are currently listening by 1 In addition, skipping a file +(with emms-skip) automatically score the file down. With scoring on (this mean the variable @var{emms-use-scoring} is t), emms will compare the score of the file with your tolerance to decide if it @@ -973,7 +1000,7 @@ @chapter How to define new players and modules EMMS introduces a high abstraction layer for playing music so you can -customize a lot of things to morph EMMS into @emph{your} media player. +customise a lot of things to morph EMMS into @emph{your} media player. @menu * New Player: new-player. How to define a new player @@ -985,10 +1012,10 @@ The file @file{emms-player-simple.el} defines some easy players to start with, but it shouldn't be hard to provide a function for your favourite player. We will start with an easy example that shows how -we can use the @command{play} command under unix to play our wav files. +we can use the @command{play} command under Unix to play our WAV files. @menu -* Example with play: example-play. Jumping into the topix +* Example with play: example-play. Jumping into the topic * More complex players: complex-player. Using mpg321 remote for example @end menu @@ -996,7 +1023,7 @@ @subsection Using @command{play} as external player Play is a very easy command line player for various format. If you -want your emms to play wav files just put the following lines in you +want your emms to play WAV files just put the following lines in you @file{.emacs}: @lisp @@ -1012,11 +1039,11 @@ defines the name of the player. It's used to name the player functions. The second is a regexp, that defines which files to play with our player. @emph{\\.wav$} matches any filename ending with a dot -and the string wav. The last arguement is the actual command line +and the string wav. The last argument is the actual command line command we use to play our files. You can also add the path but we -just asume that the command is in your path. All arguments you add to -these three are optional. They define the command line arguements you -want to add to your arguement. If you want to hear the wav file of +just assume that the command is in your path. All arguments you add to +these three are optional. They define the command line arguments you +want to add to your argument. If you want to hear the wav file of your favourite artist in the most possible volume use the following line: @@ -1026,11 +1053,11 @@ @end lisp @noindent -Please notice that you have to add the arguements as strings! +Please notice that you have to add the arguments as strings! The command line tool you use for @command{define-emms-simple-player} -has to take one song as arguement and stop after playing that -partikular song. For any other concept you will need to customize +has to take one song as argument and stop after playing that +particular song. For any other concept you will need to customise emms a bit more... @node complex-player @@ -1094,8 +1121,8 @@ @end lisp @noindent -@command{emms-mpg321-remote-stop} won't doanything interesing. It -justs test if there are other files to play and close the process otherwise. +@command{emms-mpg321-remote-stop} won't do anything interesting. It +just test if there are other files to play and close the process otherwise. @lisp (defun emms-mpg321-remote-stop ()