doc/state-save.1

   1 .ig
   2 state-save.man
   3
   4 Last update: 03 July 2005
   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-save" 1
  24 .SH "NAME"
  25 state\-save \- Program for saving the state of the Music Player Daemon (MPD)
  26 .SH "SYNOPSIS"
  27 state\-save [<state name>]
  28 .SH "DESCRIPTION"
  29 state\-save  is a client for MPD which saves all available information to [<state name>] for later restoration.
  30
  31 .SH "ARGUMENTS"
  32 .TP
  33 This section describes the argument.
  34 .br
  35 .RI [ <state name> ]
  36 is not required, but if not given state will be saved to 'default'.
  37
  38 .SH "ENVIRONMENT"
  39 .TP
  40 This section describes some environment variables that affect how state-save operates.
  41 .br
  42 .B MPD_HOST
  43 .br
  44 .B MPD_PORT
  45 .br
  46                 By default, state-save connects to localhost:6600. This can be changed either at compile-time, or by exporting the MPD_HOST and MPD_PORT environment variables.
  47 .br
  48                 To use a password with mpd, set MPD_HOST to password@host.
  49 .SH "EXAMPLES"
  50 .TP
  51 A quick example.
  52 .br
  53 MPD_HOST='password@host' MPD_PORT='6600' state-save my_state_name
  54 .SH "BUGS"
  55 This doesn't save a few different things which aren't available via the MPD protocol.
  56 .br
  57         * Any *ids such as playlistid
  58 .br
  59         * Random, if a playlist was ordered and any part of the playlist has been previously been played through the songs that have played in the previous state will be replayed.
  60 .br
  61         * Bash completion script doesn't yet work with spaces.
  62 .br
  63         * May not deal well with errors. This may change in the future.
  64 .SH "SEE ALSO"
  65 state-restore(1)
  66 .SH "AUTHOR"
  67 Avuton Olrich <avuton@gmail.com>