aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Landscheidt <tim@tim-landscheidt.de>2010-06-27 17:33:35 +0000
committerTim Landscheidt <tim@tim-landscheidt.de>2010-06-27 17:33:35 +0000
commitda9f87ffd68f7b63843da2910d94281b41f18984 (patch)
tree608f98ee6162f336a14331cb88d7c905f9ea49d4
parented6a77997d4228d6a6a3da1a880e7672a2853829 (diff)
Fix typos and spacing.
* AUTHORS, FAQ, NEWS, README, lisp/emms-bookmarks.el, lisp/emms-cache.el, lisp/later-do.el: Fix typos and spacing.
-rw-r--r--AUTHORS2
-rw-r--r--FAQ23
-rw-r--r--NEWS12
-rw-r--r--README126
-rw-r--r--lisp/emms-bookmarks.el10
-rw-r--r--lisp/emms-cache.el6
-rw-r--r--lisp/later-do.el13
7 files changed, 99 insertions, 93 deletions
diff --git a/AUTHORS b/AUTHORS
index baf82dc..f4b34b8 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -1,5 +1,5 @@
This file lists all people who contributed more than a few lines to
-emms. This is necessary to keep track of people who have copyright
+emms. This is necessary to keep track of people who have copyright
claims on sources, so please don't be too humble and add yourself.
Damien Elmes <emacs@repose.cx>
diff --git a/FAQ b/FAQ
index 0e77564..80324d9 100644
--- a/FAQ
+++ b/FAQ
@@ -1,19 +1,18 @@
-Frequently Asked Questions about emms. Please read this before
+Frequently Asked Questions about emms. Please read this before
submitting a bug report.
-Q: I seem unable to play files with accents in them. Why?
+Q: I seem unable to play files with accents in them. Why?
A: Emacs doesn't know the coding system of your files, and it
- apparently decodes them the wrong way. Set
+ apparently decodes them the wrong way. Set
`default-file-name-coding-system' to the correct encoding of your
- file names. It might even work to set it to 'undecided and let
+ file names. It might even work to set it to 'undecided and let
Emacs guess.
-Q: Emms skips some songs in the playlist for no apparent reason. When
- I select them manually, everything works. Why?
-A: Increase `emms-player-delay' until it works.
- The problem is that emms is told by Emacs that a player finished,
- so it starts a new one. But in reality, the player has not yet
- freed the audio device, so the next player gets an error when
- trying to play.
- The best way to fix this by using ALSA or other sound systems which
+Q: Emms skips some songs in the playlist for no apparent reason. When
+ I select them manually, everything works. Why?
+A: Increase `emms-player-delay' until it works. The problem is that
+ emms is told by Emacs that a player finished, so it starts a new
+ one. But in reality, the player has not yet freed the audio
+ device, so the next player gets an error when trying to play. The
+ best way to fix this is by using ALSA or other sound systems which
allow concurrent access.
diff --git a/NEWS b/NEWS
index 99a5c09..545bf9c 100644
--- a/NEWS
+++ b/NEWS
@@ -1,9 +1,9 @@
News since version 3.0:
- Drop support for emms-player-gstreamer.
- - emms-player-mplayer: Remove codes for loading movie subtitles
- automatically by emms, since mplayer has an option(`sub-fuzziness')
- controlling that.
+ - emms-player-mplayer: Remove code for loading movie subtitles
+ automatically by emms, since mplayer has an option
+ (`sub-fuzziness') controlling that.
News since version 2.1:
@@ -44,13 +44,13 @@ News since version 2.1:
emms-lastfm is loaded and active.
- emms-playing-time supports different display styles now.
- emms-lyrics: Now support lyrics auto-scrolling.
- - emms-player-mplayer: capable of loading movie subtitles
+ - emms-player-mplayer: Capable of loading movie subtitles
automatically now.
News since version 2.0:
- A new player that uses mpg321's remote mode is now available
- (emms-player-mpg321-remote) - this allows seeking and copes with
+ (emms-player-mpg321-remote)--this allows seeking and copes with
errors in files.
- A metadata browser has been added in emms-browser.el.
- Recording of the time a track was last played is now supported.
@@ -64,5 +64,5 @@ News since version 2.0:
User-visible bug fixes:
- - The emms-playlist-mode is now much faster
+ - The emms-playlist-mode is now much faster.
- MP3s with errors are now playable when using the remote player.
diff --git a/README b/README
index 16110c8..34b727a 100644
--- a/README
+++ b/README
@@ -1,79 +1,80 @@
EMMS --- The Emacs Multi-Media System -*-outline-*-
=====================================
+
* Introduction, Overview
========================
-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
+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 its ideas are derived from MpthreePlayer
(http://www.nongnu.org/mp3player), but it tries to be more general and
more clean.
The basic functionality of Emms consists of three parts: The core,
the sources, and the players.
- The core resides in `emms.el', and provides a simple playlist and the
-basic functionality to use all the other features of Emms. It provides
-the common user commands and interfaces for other parts. It thinks in
-tracks, where a track is the combination of a type and a name - e.g.
-the track type 'file has a name that is the file name. Other track
-types are possible.
+ The core resides in `emms.el', and provides a simple playlist and
+the basic functionality to use all the other features of Emms. It
+provides the common user commands and interfaces for other parts. It
+thinks in tracks, where a track is the combination of a type and a
+name--e.g., the track type 'file has a name that is the file name.
+Other track types are possible.
- To get to tracks, the core needs sources. The file
-`emms-source-file.el' provides simple sources to interact with the file
-system.
+ To get to tracks, the core needs sources. The file
+`emms-source-file.el' provides simple sources to interact with the
+file system.
- When Emms finally has the sources in the playlist, it needs a player
-to play them. `emms-player-simple.el' defines a few useful players, and
-allows you to define your own in a very simple way.
+ When Emms finally has the sources in the playlist, it needs a
+player to play them. `emms-player-simple.el' defines a few useful
+players, and allows you to define your own in a very simple way.
The way Emms works is easy to customize with your own code or by
-using `M-x customize'.
+using `M-x customize RET'.
* Installation
==============
You need to put all the .el files of EMMS in a directory in your
-load-path. For example, if you put all those files into ~/elisp/emms/,
-then in your ~/.emacs, you should do:
+load-path. For example, if you put all those files into
+~/elisp/emms/, then in your ~/.emacs you should do:
(add-to-list 'load-path "~/elisp/emms/")
-For information about compiling Emms into byte-code see the "Compiling
-Emms" section in the Emms manual.
+For information about compiling Emms into byte-code see the
+``Compiling Emms'' section in the Emms manual.
** Setup
--------
-After adding the location of the Emms code to the LOAD-PATH variable, we
-invoke the following using the `emms-setup' feature which allows for
-quick and simple Emms setup.
+After adding the location of the Emms code to the load-path variable,
+we invoke the following using the `emms-setup' feature which allows
+for quick and simple Emms setup.
(require 'emms-setup)
(emms-standard)
(emms-default-players)
- After which Emms is set-up and ready to go!
+After which Emms is set-up and ready to go!
-For more information about different setup levels and features see the
-"Simple Setup" section of the Emms manual.
+ For more information about different setup levels and features see
+the ``Simple Setup'' section of the Emms manual.
** Usage
--------
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):
+noticed. It provides a few commands to skip the current track and
+such, but otherwise, it doesn't show up. EMMS provides the following
+basic user commands (that you might want to bind to keys):
emms-start ...... Start playing the current playlist
emms-stop ....... Stop playing
emms-next ....... Go to the next track in the playlist
emms-previous ... Go to the previous track in the playlist
emms-shuffle .... Shuffle the playlist
-emms-show ....... What are you playing?
+emms-show ....... What is playing?
-But before you can use these, you need a playlist to start with. The
+But before you can use these, you need a playlist to start with. The
following commands allow you to create a playlist from different
sources:
@@ -81,18 +82,20 @@ emms-play-file ............. Play a single file
emms-play-directory ........ Play a whole directory
emms-play-directory-tree ... Play a directory tree
+
* The Interactive Playlist buffer
=================================
Emms provides a visual, interactive playlist mode as well as the
-ability to use playlists without ever looking at then. This visual,
+ability to use playlists without ever looking at them. This visual,
interactive mode is called the `emms-playlist-mode' and is defined in
`emms-playlist-mode.el'.
-To use the interactive playlist invoke: `M-x emms-playlist-mode-go'
+ To use the interactive playlist invoke: `M-x emms-playlist-mode-go
+RET'
When in the interactive playlist mode we can perform different
-actions on the current playlist. Here are some basic commands:
+actions on the current playlist. Here are some basic commands:
`n'....Start playing the next track in the playlist.
@@ -104,21 +107,22 @@ actions on the current playlist. Here are some basic commands:
`c'....Display the current track in the center of the screen.
-`RET'..Start playing the track under point. Note that this is also
- available with `<mouse-2>'.
+`RET'..Start playing the track under point. Note that this is also
+ available with `Mouse-2'.
-`q'....Put the interactive playlist buffer at the end of the list of all
- buffers (ie. bury it).
+`q'....Put the interactive playlist buffer at the end of the list of
+ all buffers (i.e., bury it).
As always, for more commands see the mode documentation and the
-"Interactive Playlists" section of the Emms manual.
+``Interactive Playlists'' section of the Emms manual.
+
* Bare Bones Setup
==================
The following code fragment provides a minimal EMMS setup without
-using the layer of `emms-default'. It can maybe be used to better
-understand the internals of EMMS. You can see how EMMS needs to know
+using the layer of `emms-default'. It can maybe be used to better
+understand the internals of EMMS. You can see how EMMS needs to know
about players (these are defined in `emms-player-simple') and about
sources for tracks (trivial file system based sources, such as this
`emms-directory-tree', are defined in `emms-source-file').
@@ -130,39 +134,41 @@ sources for tracks (trivial file system based sources, such as this
emms-player-ogg123
emms-player-mplayer))
+
* Advanced configuration
========================
** Seeking
----------
In most multimedia players, you can seek forward or backward in a
-track. EMMS supports this too. If you're using mplayer, check that
-`emms-player-mplayer-parameters' contains "slave". If you're using
-mpg321, there is a module called emms-player-mpg321-remote.el. To use
-it, simply add the following lines to your configuration :
+track. EMMS supports this too. If you're using mplayer, check that
+`emms-player-mplayer-parameters' contains ``slave''. If you're using
+mpg321, there is a module called emms-player-mpg321-remote.el. To use
+it, simply add the following lines to your configuration:
(require 'emms-player-mpg321-remote)
(push 'emms-player-mpg321-remote emms-player-list)
Finally, if you are using mpd, no special config is needed.
-Seeking works through the following functions :
+ Seeking works through the following functions:
`emms-seek' which takes a negative or positive amount of seconds.
`emms-seek-forward' which seeks ten seconds forward.
`emms-seek-backward' which seeks ten seconds backward.
+
* Using libtag for reading tags
===============================
There is a way to read tags using Libtag as your backend for
-emms-info. However, since it requires a binary file (source code
-provided with EMMS), it isn't enabled by default. To compile it, type
-"make emms-print-metadata". To install it, either put
-emms-print-metadata in your $PATH, or add emms directory to Emacs'
-exec-path. Since, libtag overwrites most of the usual methods for
+emms-info. However, since it requires a binary file (source code
+provided with EMMS), it isn't enabled by default. To compile it, type
+``make emms-print-metadata''. To install it, either put
+emms-print-metadata in your $PATH, or add EMMS' directory to Emacs'
+exec-path. Since libtag overwrites most of the usual methods for
providing info, it's best to keep it as the only function in
-`emms-info-functions'. Here's a way to do so:
+`emms-info-functions'. Here's a way to do so:
(require 'emms-info-libtag)
(setq emms-info-functions '(emms-info-libtag))
@@ -171,12 +177,13 @@ providing info, it's best to keep it as the only function in
* EMMS, Emms, emms, or what?
============================
-In various contexts, this program is called EMMS, Emms or emms. Those
-are all correct, and which you use is a matter of personal preference.
-EMMS highlights the acronym character of the name. Emms is akin to
-Emacs and Gnus, ignoring that Emms is pronounce ee-em-em-es, and not a
-single name. emms is highlighting that emms is a case-sensitive file
-name and Emacs Lisp command.
+In various contexts, this program is called EMMS, Emms or emms. Those
+are all correct, and which one you use is a matter of personal
+preference. EMMS highlights the acronym character of the name. Emms
+is akin to Emacs and Gnus, ignoring that Emms is pronounced
+ee-em-em-es, and not a single name. emms is highlighting that emms is
+a case-sensitive file name and Emacs Lisp command.
+
* Getting help
==============
@@ -186,7 +193,8 @@ visit http://lists.gnu.org/mailman/listinfo/emms-help. If you are
familiar with the Gmane service, there is a Gmane newsgroup which
mirrors this mailing address at gmane.emacs.emms.user.
-Emms also has a website at <http://www.gnu.org/software/emms/>.
+ Emms also has a website at <http://www.gnu.org/software/emms/>.
+
* License
=========
diff --git a/lisp/emms-bookmarks.el b/lisp/emms-bookmarks.el
index 5e6f516..e3b1747 100644
--- a/lisp/emms-bookmarks.el
+++ b/lisp/emms-bookmarks.el
@@ -23,12 +23,12 @@
;;; Commentary:
;;
-;; You can use this to add "temporal bookmarks" (term by Lucas Bonnet)
-;; into your media files. The interesting functions here are
+;; You can use this to add ``temporal bookmarks'' (term by Lucas
+;; Bonnet) to your media files. The interesting functions here are
;; `emms-bookmarks-next', `emms-bookmarks-prev', `emms-bookmarks-add'
;; (which pauses the player while you describe the bookmark) and
-;; `emms-bookmarks-clear'. All of which do exactly what you think they
-;; do.
+;; `emms-bookmarks-clear'. All of which do exactly what you think
+;; they do.
;;; Code:
@@ -132,7 +132,7 @@ FAILURE-MESSAGE should be a string."
(defun emms-bookmarks-add ()
"Add a new bookmark to the current track.
-This function pauses the player while promting the user for a
+This function pauses the player while prompting the user for a
description of the bookmark. The function resumes the player
after the prompt."
(interactive)
diff --git a/lisp/emms-cache.el b/lisp/emms-cache.el
index 2262c7c..4741cbf 100644
--- a/lisp/emms-cache.el
+++ b/lisp/emms-cache.el
@@ -25,11 +25,11 @@
;;; Commentary:
;; The cache is a mapping of a full path name to information, and so
-;; it is invalidated when you rename or move files about. It also does
-;; not differentiate between file or uri tracks.
+;; it is invalidated when you rename or move files about. It also
+;; does not differentiate between file or uri tracks.
;; Because cache lookups are much faster than disk access, this works
-;; much better with a later-do-interval of something like 0.001. Also
+;; much better with a later-do-interval of something like 0.001. Also
;; consider using synchronous mode, as it's quite fast now.
;; This code is activated by (emms-standard) and above.
diff --git a/lisp/later-do.el b/lisp/later-do.el
index 61be86b..d8222ae 100644
--- a/lisp/later-do.el
+++ b/lisp/later-do.el
@@ -22,7 +22,7 @@
;;; Commentary
-;; This file will execute lisp code "later on". This way it is
+;; This file will execute lisp code ``later on''. This way it is
;; possible to work while elisp does some longer calculations, if you
;; can convert those calculations into a sequence of function calls.
@@ -42,17 +42,16 @@
:type 'number)
(defvar later-do-list nil
- "A list of functions to be called lateron.")
+ "A list of functions to be called later on.")
(defvar later-do-timer nil
"The timer that later-do uses.")
(defun later-do (function &rest args)
- "Apply FUNCTION to ARGS later on. This is an unspecified amount of
-time after this call, and definitely not while lisp is still
-executing.
-Code added using `later-do' is guaranteed to be executed in the
-sequence it was added."
+ "Apply FUNCTION to ARGS later on. This is an unspecified
+amount of time after this call, and definitely not while lisp is
+still executing. Code added using `later-do' is guaranteed to be
+executed in the sequence it was added."
(setq later-do-list (nconc later-do-list
(list (cons function args))))
(unless later-do-timer