herrie/man/00-man

   1 .\"
   2 .\" Copyright (c) 2006-2011 Ed Schouten <ed@80386.nl>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .TH HERRIE 1 "January 1, 2008" "Ed Schouten"
  27 .SH NAME
  28 herrie \- interactive music playlist player
  29 .SH SYNOPSIS
  30 .B herrie
  31 .RB [ -pvx ]
  32 .RB [ -c
  33 .IR configfile ]
  34 .RI [ file
  35 .IR ... ]
  36 .SH DESCRIPTION
  37 .B herrie
  38 is a command line music player. It supports multiple audio file formats
  39 (including MP3 and Ogg Vorbis) and has the ability to send playback
  40 statistics to AudioScrobbler. The word `herrie' is Dutch for `clamour'.
  41 .PP
  42 .B herrie
  43 uses a split-screen user interface: a playlist at the top and a
  44 filebrowser at the bottom. The application has two modes of operation,
  45 called `party mode' and `XMMS mode'. When the application is started in
  46 party mode, the first song in the playlist gets started. It will also be
  47 removed from the playlist as well. When the application is started in
  48 XMMS mode, any song can be started and will not be removed from the
  49 playlist.  The default mode is party mode.
  50 .PP
  51 The following command line options are available:
  52 .TP
  53 .BI "-c " "configfile"
  54 By default,
  55 .B herrie
  56 searches in
  57 .I ~/.herrie/config
  58 or in the system wide global configuration file
  59 .I %%CONFFILE%%
  60 for options. The
  61 .B -c
  62 options allows you to load additional configuration files.
  63 .TP
  64 .B -p
  65 Automatically start playback on startup.
  66 .TP
  67 .B -v
  68 Display version information and a list of supported file formats.
  69 .TP
  70 .B -x
  71 This switch causes
  72 .B herrie
  73 to start up in XMMS mode.
  74 .PP
  75 Files that are passed on the command line will be appended to the
  76 playlist.
  77 .SH KEYBOARD BINDINGS
  78 Both the file browser and the playlist share some common keyboard
  79 bindings:
  80 .TP
  81 .B j or down arrow
  82 Move the selection one entry down.
  83 .TP
  84 .B k or up arrow
  85 Move the selection one entry up.
  86 .TP
  87 .B ^F, page down or spacebar
  88 Move the selection one page down.
  89 .TP
  90 .B ^B or page up
  91 Move the selection one page up.
  92 .TP
  93 .B f
  94 Show the full pathname of the selected song.
  95 .TP
  96 .B F
  97 Jump to the selected file in the file browser.
  98 .TP
  99 .B g or home
 100 Move the selection to the top.
 101 .TP
 102 .B G or end
 103 Move the selection to the bottom.
 104 .TP
 105 .B /
 106 Search the entries for a specified regular expression and select the
 107 first matching entry below the current selection. If no match is found,
 108 the search will continue at the top of the list. As a final attempt, the
 109 other window is searched as well.
 110 .TP
 111 .B n
 112 Perform another search for the last entered search string.
 113 .PP
 114 There are also some bindings that only apply to the playlist:
 115 .TP
 116 .B d
 117 Remove the currently selected song from the playlist.
 118 .TP
 119 .B D
 120 Remove all songs from the playlist.
 121 .TP
 122 .B R
 123 Randomize the playlist.
 124 .TP
 125 .B [
 126 Move the currently selected song upward.
 127 .TP
 128 .B ]
 129 Move the currently selected song downward.
 130 .TP
 131 .B {
 132 Move the currently selected song to the top of the playlist.
 133 .TP
 134 .B }
 135 Move the currently selected song to the bottom of the playlist.
 136 .TP
 137 .B ~
 138 Navigate back to the directory specified in
 139 .B gui.browser.defaultpath .
 140 .PP
 141 The file browser also has some bindings that allow you to traverse the
 142 file system or add files, directories or playlists (M3U and PLS) to the
 143 playlist:
 144 .TP
 145 .B a
 146 Add items after the current selected item in the playlist.
 147 .TP
 148 .B A
 149 Add items at the end of the playlist.
 150 .TP
 151 .B i
 152 Add items before the current selected item in the playlist.
 153 .TP
 154 .B I
 155 Add items at the beginning of the playlist.
 156 .TP
 157 .B h or left arrow
 158 Go one directory up.
 159 .TP
 160 .B l or right arrow
 161 Enter the selected directory.
 162 .TP
 163 .B L
 164 Locate all files in the current and underlying directories matching a
 165 search string. When finished, all matching files will be showed in a
 166 list. To remove an existing filter, go one directory up.
 167 .TP
 168 .B C
 169 Change the current directory by entering a pathname. This pathname may
 170 be relative to the current directory. When the address refers to a file
 171 or web location, it will be displayed as well.
 172 .PP
 173 And last but not least, there are also some general keyboard bindings: