doc/state-sync.1

   1 .ig
   2 state-sync.man
   3
   4 Last update: 01 September 2006
   5
   6 Copyright (C) 2005-2009 Avuton Olrich <avuton@gmail.com>
   7
   8 Permission is granted to copy, distribute and/or modify this document
   9 under the terms of the GNU Free Documentation License, Version 1.1 or
  10 any later version published by the Free Software Foundation; with the
  11 Invariant Sections being this .ig-section and AUTHOR, with no
  12 Front-Cover Texts, and with no Back-Cover Texts.
  13
  14 A copy of the Free Documentation License is included as a file called
  15 FDL in the main directory of the state-utils source package.
  16 ..
  17 .
  18 .\" --------------------------------------------------------------------
  19 .\" Setup
  20 .\" --------------------------------------------------------------------
  21 .
  22 .do
  23 .TH "state-sync" 1
  24 .SH "NAME"
  25 state\-sync \- Program for syncronizing the state of multiple Music Player Daemons (MPD)
  26 .SH "SYNOPSIS"
  27 state\-sync
  28 .RI [ <password@origin-host:origin-port> <password@destination-host:destination-port> ]
  29 .B ..
  30 .SH "DESCRIPTION"
  31 state\-sync is a client for MPD which syncronizes multiple MPD clients. It is not meant to sync accurately to the second, but more to put things near the same place.
  32
  33 .SH "ARGUMENTS"
  34 .TP
  35 This section describes the argument.
  36 .br
  37 .RI [ <pass@origin-host:origin-port> <pass@destination-host1:destination-port1> ... ]
  38 the origin host/port are in the first argument, every argument afterwards is synced with the origin.
  39
  40 .br
  41   There can be mutiple values separated by spaces.
  42
  43 .SH "ENVIRONMENT"
  44 .TP
  45 This is how to configure state-sync for the origin MPD to take the state from.
  46 .br
  47 .B MPD_HOST
  48 .br
  49 .B MPD_PORT
  50 .br
  51                 By default, state-amend connects to localhost:6600. This can be changed either
  52 .br
  53                   at compile-time, or by exporting the MPD_HOST and MPD_PORT environment variables.
  54 .br
  55                 To use a password with mpd, set MPD_HOST to password@host.
  56 .SH "EXAMPLES"
  57 .TP
  58 A quick example.
  59 .br
  60 state-sync password1@origin:6600 password2@destination:6600
  61 .SH "BUGS"
  62 This doesn't save a few different things which aren't available via the MPD protocol.
  63 .br
  64 \- Any *ids such as playlistid
  65 .br
  66 \- Random, if a playlist was ordered and any part of the playlist has been previously
  67 .br
  68   been played through the songs that have played in the previous state will be replayed.
  69 .br
  70 \- Random will not play in order as the other server.
  71 .br
  72 \- The databases must be up-to-date, and identical, otherwise the syncronization will fail.
  73 .br
  74 \- Bash completion script doesn't yet work with spaces.
  75 .br
  76 \- May not deal well with errors. This may change in the future.
  77 .br
  78 \- The sync will never be exact, it will be anywhere from 10msec to a second initially, optimally, this is due to limitations of the protocol, well beyond the control of this program. Please contact the maintainer if you have an idea of how to improve the initial latency.
  79 .SH "AUTHOR"
  80 Avuton Olrich <avuton@gmail.com>