positron/doc/commands.html

   1 <html>
   2 <head>
   3   <link rel="stylesheet" type="text/css" href="style.css" />
   4   <title>Positron User's Guide: Command Reference</title>
   5 </head>
   6 <body>
   7 <h1>Positron User's Guide: Command Reference</h1>
   8
   9 <h2>General</h2>
  10
  11 <p>
  12 The general syntax for positron is:
  13 <pre>
  14 positron [-c config_dir] [-m mountpoint] [command] [command arguments]
  15 </pre>
  16
  17 <dl class="option">
  18
  19 <dt>-m mountpoint, --mount-point=mountpoint</dt>
  20 <dd>The directory where the Neuros is mounted.  This overrides
  21 whatever is stored in the configuration file.</dd>
  22
  23 <dt>-c config_dir, --config=config_dir</dt>
  24 <dd>The directory where the positron configuration is stored.  By
  25 default this is <tt>~/.positron</tt>.</dd>
  26
  27 </dl>
  28 The commands are described below.
  29 </p>
  30
  31 <h2 id="add">add</h2>
  32
  33 <p>
  34 Adds files to the Neuros database, copying as necessary.  Files that
  35 are already on the Neuros will not be overwritten, but just added to
  36 the database if not already present.  Non-music files are ignored.
  37 </p>
  38
  39 <h3>Usage</h3>
  40
  41 <dl class="option">
  42 <dt>
  43 positron add [sourcefile] [targetfile]
  44 </dt>
  45 <dd>
  46 Copies sourcefile to targetfile (a path on the Neuros that does not exist)
  47 </dd>
  48
  49 <dt>
  50 positron add [sourcefile1] [sourcefile2] ... [targetdir]
  51 </dt>
  52 <dd>
  53 Copies sourcefiles to targetdir (a directory on the Neuros that already
  54 exists)
  55 </dd>
  56
  57 <dt>
  58 positron add [sourcefile1] [sourcefile2] ...
  59 </dt>
  60 <dd>
  61 Copies sourcefiles to the default music directory.  Copy directories
  62 to the default music directory the same way.
  63 </dd>
  64 </dl>
  65
  66 <h2 id="del">del</h2>
  67
  68 <p>
  69 Removes files both from the Neuros database and from the Neuros
  70 filesystem.  Positron will only delete files that have database
  71 entries, and will remove directories only if they are empty.  Positron
  72 remembers which files have been deleted using this command, and will
  73 not recopy them during <a href="#sync">synchronization</a>.  Deleted
  74 files can be recopied using the <a href="#add">add</a> command.  The
  75 list of deleted files can also be purged using the
  76 <tt>--reset-deleted</tt> option to the <a href="#sync">sync</a>
  77 command.
  78 </p>
  79
  80 <h3>Usage</h3>
  81
  82 <dl class="option">
  83 <dt>
  84 positron del [files or directories]
  85 </dt>
  86 <dd>
  87 Searches a list of files and/or directories on
  88 the Neuros itself (ex: /mnt/neuros/music/rock) to be removed.
  89 Directories will be recursively searched for music files to delete.
  90 </dd>
  91 </dl>
  92
  93 <h2 id="clear">clear</h2>
  94 <p>
  95 Clears all entries from the databases.  This does not remove any
  96 files, however.
  97 </p>
  98
  99 <h3>Usage</h3>
 100
 101 <dl class="option">
 102 <dt>
 103 positron clear
 104 </dt>
 105 <dd>
 106 Clears all databases.
 107 </dd>
 108
 109 <dt>
 110 positron clear [database1] [database2] ...
 111 </dt>
 112 <dd>
 113 Clears all entries from a particular database.  Valid database names
 114 are: audio, pcaudio, unidedhisi, idedhisi, failedhisi
 115 </dd>
 116 </dl>
 117
 118 <h2 id="config">config</h2>
 119 <p>
 120 Creates or modifies the current configuration interactively.  Positron
 121 will ask you a series of questions and create a configuration files
 122 based upon your answers.  If you already have a configuration, those
 123 options will be the default answers.  See the
 124 <a href="config.html">configuration guide</a> for more information.
 125 </p>
 126
 127 <h2 id="help">help</h2>
 128 <p>
 129 Displays help information about positron commands.
 130 </p>
 131
 132 <h3>Usage</h3>
 133
 134 <dl class="option">
 135 <dt>
 136 positron help
 137 </dt>
 138 <dd>
 139 Shows general help about positron and a brief listing of commands.
 140 </dd>
 141
 142 <dt>
 143 positron help [command]
 144 </dt>
 145 <dd>
 146 Displays detailed help about a specific command.
 147 </dd>
 148 </dl>
 149
 150 <h2 id="list">list</h2>
 151
 152 <p>
 153 Lists all of the entries in a database.  Only listing the audio
 154 database is supported at this time.
 155 </p>
 156
 157 <h3>Usage</h3>
 158 <dl class="option">
 159 <dt>
 160 positron list
 161 </dt>
 162 <dd>
 163 Lists entries in the audio database
 164 </dd>
 165
 166 <dt>
 167 positron list [database1] [database2] ...
 168 </dt>
 169 <dd>
 170 List all entries from a particular database.  Valid database names
 171 are: audio, pcaudio, unidedhisi, idedhisi, failedhisi
 172 </dd>
 173 </dl>
 174
 175 <h2 id="pack">pack</h2>
 176
 177 <p>
 178 Removes unused space from databases.  This is created when entries are
 179 deleted from the database.  Note that packing is automatically done
 180 whenever you <a href="#sync">synchronize</a> with positron, so you
 181 should seldom need to do this manually.
 182 </p>
 183
 184 <h3>Usage</h3>
 185
 186 <dl class="option">
 187 <dt>
 188 positron pack
 189 </dt>
 190 <dd>
 191 Packs all databases.
 192 </dd>
 193
 194 <dt>
 195 positron pack [database1] [database2] ...
 196 </dt>
 197 <dd>
 198 Packs all entries from a particular database.  Valid database names
 199 are: audio, pcaudio, unidedhisi, idedhisi, failedhisi
 200 </dd>
 201 </dl>
 202
 203 <h2 id="rebuild">rebuild</h2>
 204
 205 <p>
 206 Recreates the Positron databases from the music tracks found on the
 207 Neuros.  This command completed wipes the Neuros databases and
 208 rebuilds them from scratch.  It is needed if your databases have
 209 become corrupted.  Positron will locate all of the music files already
 210 on the Neuros and put their entries back into the database as best as
 211 it can guess.  The database of music stored on your computer
 212 ("pcaudio") will cleared and all HiSi clips will be marked as
 213 unidentified even if they had been previously identified.
 214 </p>
 215
 216 <h3>Usage</h3>
 217 <dl class="option">
 218 <dt>
 219 positron rebuild
 220 </dt>
 221 <dd>
 222 Rebuilds all of the databases.
 223 </dd>
 224 </dl
 225
 226 <h2 id="sync">sync</h2>
 227
 228 <p>
 229 Synchronizes your Neuros with your music library.  This will scan all
 230 of the syncpoints specified during <a
 231 href="config.html">configuration</a> for new files and copy them to
 232 your Neuros.  It also scans your Neuros for new FM, microphone or
 233 line-in recordings and copies them to your, if you specified a
 234 location for them during configuration.
 235 </p>
 236
 237 <p>
 238 Positron remembers which files have been removed with <tt>positron
 239 del</tt> and which recordings have already been copied to the
 240 computer.  They will not be recopied.  You can clear these lists with the options shown below.
 241 </p>
 242
 243 <h3>Usage</h3>
 244
 245 <dl class="option">
 246 <dt>
 247 positron sync
 248 </dt>
 249 <dl>
 250 Synchronizes Neuros with your computer.
 251 </dl>
 252
 253 <dt>
 254 positron sync --reset-deleted
 255 </dt>
 256
 257 <dd>
 258 Clears the list of deleted tracks.  This does not perform
 259 synchronization.  Rerun <tt>sync</tt> without options to
 260 synchronize.
 261 </dd>
 262
 263 <dt>
 264 positron sync --reset-recordings
 265 </dt>
 266
 267 <dd>
 268 Clears the list of recordings that have already been copied to the
 269 computer.  This does not perform synchronization.  Rerun <tt>sync</tt>
 270 without options to synchronize.
 271 </dd>
 272 </dl>
 273
 274 </body>
 275 </html>