HARP README

Table of Contents

  1. Installation and Setup
  2. Manager Interface
    1. Insert
    2. Edit
    3. List
    4. Admin
  3. Customization
    1. Configuration File
  4. Requirements


I. Installation and Setup

  • Installing harp:
    • ./configure
      • To build without certain plugins use --without-pluginname:
      • ./configure --without-flac --without-vorbis
      • Currently available are mp3, aac, vorbis, flac and stream
      • To use a different sound output (OSS is the default), use:
      • ./configure --with-jack
      • or
      • ./configure --with-alsa
      • MacPorts users may wish to configure with:
      • ./configure --with-jack CFLAGS="-I/opt/local/include" LDFLAGS="-L/opt/local/lib -L/opt/local/lib/jack"
      • See also in the .tar.gz package: osx_install.sh
    • make
    • make install
  • Enable the plugins in harp
    • harp -a
    • select plugin management
    • admin> m
    • add a plugin
    • manage plugins> a
    • Library (e.g., libharpmp3): libharpmp3
    • manage plugins> a
    • Library (e.g., libharpmp3): libharpaac
    • ...
  • Check that the plugins have been installed:
    • list added plugins
    • manage plugins> l
  • (optional) Create a configuration file:
  • Note: your paths may be different.
    • cp /usr/local/share/harp/defaults.conf ~/.harp/defaults.conf


II. Manager Interface

  • Insert
    • Song
      • Insert a song into the system. If the insert flag is given with no argument, songs may be entered at the prompt. Inserts may be given with an argument of the song path to add a song from the command line. If a directory is given as an argument, HARP will scan the directory recursively and add all valid files into the system.
  • List
    • List detailed song information or list the songs related to an album, artist, or playlist. If given no argument, all members of that category are listed.
  • Edit
    • Global commands:
    • qQuit
      pPrevious menu
      ?Print help

    • Edit commands:
    • NOTE: These commands take an argument of the IDs(or names) separated by commas.
    • sEdit song(s)
      saEdit songs in specified album.
      srEdit songs in specified artist.
      sgEdit songs in specified genre.
      aEdit album(s).
      rEdit artist(s).
      pEdit playlist(s).
      gEdit genre(s).

      • Song commands:
      • NOTE: Commands that require additional input can take it as an argument
        (e.g., t NewTitle)
      • LList the songs that will be affected.
        tChange the title of the song.
        lChange the location of the song.
        rChange the song's artist.
        aChange the song's album.
        dRemove the song from the database. The original file will remain intact.
        vToggle Activation: Toggle the active status of the song. Provide an argument of 0 to deactivate or 1 to activate the selected songs. Default behaviour is to flip the status of each song. Deactivated songs are similar to deleted songs except that they keep their play statistics and may be played only if reactivated or if directly chosen to be played with the --type=s flag.
        gChange which genres the song belongs to.
        • Song-Genre commands:
        • LList which genres the song belongs to.
          aAdd the song to a genre.
          rRemove the song from a genre.

      • Album commands:
      • NOTE: Commands that require additional input can take it as an argument
        (e.g., t NewTitle)
      • LList the albums that will be affected.
        tChange the album's title.
        rChange the album's artist.

      • Artist commands:
      • NOTE: Commands that require additional input can take it as an argument
        (e.g., n NewName)
      • LList the artists that will be affected.
        nChange the artist's name.

      • Playlist commands:
      • NOTE: Commands that require additional input can take it as an argument
        (n NewName) or (o 10 4)
      • LList the playlist that will be affected.
        LCList the contents of the playlist that will be affected.
        cCreate a new playlist.
        nChange the name of the playlist.
        dDelete the playlist. Songs will remain in the database.
        aAdd a song to the playlist.
        rRemove a song from the playlist. (Takes an argument of Order. Not SongID)
        oChange the order of a song in the playlist. (Takes two arguments: current order and new order)
      • Genre commands:
      • NOTE: Commands that require additional input can take it as an argument
        (e.g., n NewName)
      • nChange the name of the genre.
        dDelete the genre. If a song is left without any genres, it will be added to the 'Unknown' genre at the end of the session.
        aAdd a genre.
        oChange the genre's owner (parent).
  • Admin
    • Manage Plugins
    • aAdd
      Add a plugin to the system. Plugin must already be installed.
      lList
      List all plugins in the system.
      rRemove
      Remove a plugin from the system.
      tToggle activation
      Toggle the activation status of a plugin. Deactivated plugins will only be used if all activated plugins of the correct type are unavailable.
      PluginID can either be given as:
      manage plugins> t x
      or
      manage plugins> t
      PluginID: x
      where x is the PluginID
    • Manage Stats
    • eExport stats
      Stats will be output to a file in tab separated columns sorted by file location.
      rReset stats
      aReset all stats.
      rReset ratings.
      dReset play count.
      sReset skip count.
      lReset last play time.


III. Customization

  • Configuration File:
    • This located at ~/.harp/defaults.conf
    • General format for this file:
      • Comments start with #
      • Section names are enclosed in []
      • Options are in the format: option=setting


IV. Requirements

  • Sound output:
    • OSS, JACK, or ALSA
  • Database:
    • SQLite3
  • Default Decoders:
    • MP3: libmpg123
    • AAC: libfaad2
    • OGG: libvorbisfile
    • FLAC: libFLAC

Links


Project hosted by:
Get HARP at SourceForge.net. Fast, secure and Free Open Source software downloads