README.SBo 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. ** Auto-saved playlist file **
  2. By default, when you exit herrie your current playlist is saved to
  3. ~/.herrie/autosave.pls. This list is automatically loaded at the next startup of
  4. herrie.
  5. *NOTE* The file will not be created unless the full path to it exists (it is not
  6. created by herrie). Therefore, by default you will need to create your ~/.herrie
  7. folder. The config option, playq.dumpfile, can be used to change the default
  8. location of the autosave.pls file.
  9. ** The Config file **
  10. The global config file is by default at /etc/herrie.conf.
  11. User-specific settings can be set by creating a config file at ~/.herrie/config.
  12. The '-c' argument allows you to specify a different config file other than
  13. these defaults. Please note that config settings are overidden on a per setting
  14. basis. For instance, if gui.browser.defaultpath is specified in /etc/herrie.conf,
  15. but it is not specified in ~/.herrie/config then the setting in /etc/herrie.conf
  16. will be used. The other settings that are in ~/.herrie/config would still be used.
  17. ** AutoPlay **
  18. Herrie can be configured to begin playback at startup by setting
  19. playq.autoplay=yes
  20. in the config file. Alternatively, you can run herrie with the '-p' switch.
  21. ** AutoQuit **
  22. Herrie can be configured to automatically exit after playing the last song in the
  23. playlist by setting
  24. playq.autoquit=yes
  25. in the config file. Alternatively, you can run herrie with the '-q' switch.
  26. Do note that, by definition, using autoquit ignores 'repeat' since you will want
  27. herrie to quit after the playlist finishes.
  28. ** Skip Command Confirmation **
  29. If you would like to skip the Yes/No confirmation dialog when quitting herrie,
  30. removing all files from the playlist queue, and other commands then set
  31. gui.input.confirm=no
  32. in the config file.
  33. ** File Filtering **
  34. Herrie can be configured to perform file filtering in two different ways:
  35. 1) Filter only when adding whole folders to the playlist
  36. vfs.ext.whitelist is used as the config option and its default is currently
  37. "mp3 wav ogg". If it is set to "" (blank) then filtering is turned off.
  38. Each file extension whitelisted must have *one* space in between them.
  39. No '.'s are needed and the extensions are case insensitive.
  40. 2) Filter files always (including in file browser)
  41. To make non-whitelisted file types essentially invisible (works the same as
  42. vfs.dir.hide_dotfiles) simply set
  43. vfs.dir.hide_extfiles=yes
  44. in the config file. Note, vfs.ext.whitelist is used to specify which file
  45. extensions are whitelisted. Also, like vfs.dir.hide_dotfiles, this setting
  46. does not hide files within playlist files.
  47. ** Remote Control of Herrie **
  48. Sending signals to herrie will cause it to perform certain actions.
  49. SIGUSR1 PAUSE
  50. SIGUSR2 NEXT
  51. SIGRTMIN+1 PLAY
  52. SIGRTMIN+2 STOP
  53. SIGRTMIN+3 PREVIOUS
  54. An included script, herriectl, sends these signals to all running instances of
  55. herrie with the same effective uid as the process running the script. The
  56. signal sent is based upon the input argument. The short args correspond to the
  57. keyboard shortcuts for controlling herrie (XMMS style play control). Please run
  58. herriectl with "-h" or "--help" to see the full usage.
  59. ** Chroot Mode **
  60. Be sure that the user you use for vfs.lockup.user is the OWNER of the folder used
  61. for vfs.lockup.chroot. For some reason it is not enough to have read permissions
  62. through a group. Also, note that other settings that use paths, such as
  63. gui.browser.defaultpath and playq.dumpfile will use the chrooted path. You might
  64. need to create a .herrie folder under your chrooted folder in order to be able to
  65. automatically save your playlists.
  66. Also, herrie will not work properly when using AO in chroot mode!
  67. ALSA is now the default sound system used because of this.
  68. Here is an example config file for using herrie in chroot mode:
  69. # Herrie Config file for chrooted herrie
  70. gui.browser.defaultpath=/
  71. vfs.lockup.chroot=/mnt/MEDIA/MyMusic
  72. vfs.lockup.user=USERNAME
  73. playq.dumpfile=/.herrie/autosave.pls
  74. ** Using AO **
  75. If AO is chosen as the sound output an option can be specified in the
  76. config file.
  77. Config Examples of Using AO:
  78. # Useful for KDE users
  79. audio.output.ao.driver=arts
  80. # For sending sound output to a remote SSH session
  81. audio.output.ao.driver=esd
  82. audio.output.ao.host=env_ssh
  83. ** For More Information... **
  84. Please refer to the man page for the keyboard control bindings
  85. and for more config options. An online version of the man page
  86. can be found at http://herrie.info/herrie.1