3 <link rel=
"stylesheet" type=
"text/css" href=
"style.css" />
4 <style type=
"text/css">
5 h4
{ margin-top: 1em; }
7 <title>Positron User's Guide: Configuration
</title>
10 <h1>Positron User's Guide: Configuration
</h1>
13 Now that you've got the operating system all set, and positron
14 installed, it's time to create a positron configuration file. Login
15 as a normal user, connect your Neuros to your computer, and mount it.
18 <h2>Guided Configuration
</h2>
21 Positron includes a command to help you generate and modify the
22 configuration file. The next few sections will guide you through a
23 sample configuration. To begin configuration, type the following:
28 Positron will now ask you a series of questions that will allow it
29 to generate a configuration file for you.
32 <h3>Setting the Mountpoint
</h3>
36 Positron configuration
38 Please connect your Neuros to your computer and mount it.
39 Press return when ready.
42 Hopefully, you've already done this. If not, now is the time.
47 Where is your Neuros mounted? []
50 This the mountpoint you specified during
51 <a href=
"install.html#mount">installation
</a>. If you followed the
52 example, your answer will be
<tt>/mnt/neuros
</tt>. Pressing enter
53 without typing anything will automatically select the answer given in
54 brackets. Since you don't already have a configuration file, nothing
55 is shown in the brackets.
59 If your Neuros is mounted to the directory you type in, you should see
62 Neuros found at that mountpoint.
64 If it is not mounted, or you type the wrong directory, you will see
67 Warning: A Neuros does not appear to be mounted at /blah.
68 Would you like to try a different mountpoint? [Y/n]
70 Here you can type
<tt>y
</tt> to go back and change your answer.
73 <h3>Synchronizing Recordings
</h3>
76 Once you select the mountpoint, the config script will ask you:
78 Positron can copy new FM and microphone recordings from your Neuros to your
79 computer when you synchronize with
"positron sync".
81 Would you like to enable this feature? [Y/n]
83 This is a useful feature if you want the recordings you make with
84 the Neuros to be saved to your computer's hard disk automatically
85 during synchronization. If you select this option, you will be asked
88 Where should recordings be copied to? []
91 You can pick any directory, include one inside a directory you plan to
92 make a synchronization point (see next question).
95 <h3>Selecting syncpoints
</h3>
99 Positron can automatically find new music files in the directories you
100 specify and copy them to the Neuros during synchronization.
102 Would you like to configure this? [Y/n]
105 This question is asking if you want to select one or more directories
106 (called
"synchronization points" or
"syncpoints" for short in this
107 document) to watch for new music files. Whenever you run
<tt>positron
108 sync
</tt>, positron will search all of the syncpoints, and all of
109 their subdirectories, for files that have not been loaded onto the
110 Neuros and copy them. This is very convenient if you want to keep a
111 copy of your entire music collection on the Neuros. If you have a
128
112 MB Neuros, you probably will not want to use this feature, as it is
113 very likely your music collection is bigger than
128 MB. You can
114 manually add and remove files without defining syncpoints, as
115 described in the section on
<a href=
"common-tasks.html#add">adding
120 If you choose to configure syncpoints, you will be taken to a menu:
122 Synchronized directories
123 ------------------------
124 (Format: [source directory] =
> [subdirectory on neuros]
126 No synchronized directories specified!
128 [a]dd another synchronized directory
129 [r]emove a synchronized directory
134 Since this is your first time configuring, no syncpoints are defined.
135 The
<tt>a
</tt> option will let you create a new syncpoint:
137 Enter the directory on your computer to synchronize with.
141 Type the name of the music folder on your computer here.
142 (For example, I store all my music in
<tt>/home/stan/music
</tt>.)
145 Enter the subdirectory on the Neuros to copy files to. Do not include the path
146 to the Neuros mountpoint. [Leave blank to use default]
150 Files and directories inside the syncpoint you specified
151 above will be copied into this directory on the Neuros.
152 <tt>MUSIC
<tt> is the default answer to this question.
156 To see how this works, consider the following scenario:
158 <li>Your Neuros is mounted at
<tt>/mnt/neuros
</tt>.
</li>
159 <li><tt>/home/stan/music
</tt> is a syncpoint.
</li>
160 <li><tt>tunes
</tt> is the corresponding destination directory
</li>
162 Then the file
<tt>/home/stan/music/a.mp3
</tt> will be copied to
163 </tt>/mnt/neuros/tunes/a.mp3
</tt> when you synchronize.
169 Once you have the syncpoints configred to your satisfaction, you can
170 say that you are done configuring:
173 Synchronized directories
174 ------------------------
175 (Format: [source directory] =
> [subdirectory on neuros]
177 1) /home/stan/music =
> MUSIC
179 [a]dd another synchronized directory
180 [r]emove a synchronized directory
188 Neuros Mountpoint = /mnt/neuros
189 Recording Directory = /home/stan/music/recordings
191 Synchronized directories
192 ------------------------
193 (Format: [source directory] =
> [subdirectory on neuros]
195 1) /home/stan/music =
> MUSIC
197 Write this configuration to disk? [Y/n]
199 If you say yes here, the configuration will be written, and you
200 will be ready to start using positron.
203 <h2>Configuration File Format
</h2>
206 You can also edit the configuration file directly. The positron
207 config files is stored by default in
<tt>~/.positron/config
</tt>. You
208 can edit it as a normal text file. It is composed of two types of entries:
212 <li>Key-value pair - This is a name followed by an equal sign,
213 followed by the value. Spaces around the value are trimmed, and if
214 the value needs to contain a space, it should be enclosed in
217 <li>Block - This starts with
<tt>begin
</tt> and the name of the type
218 of block, and is followed by
<tt>end
</tt> and the name of the
219 block. Inside the block are key-value pairs.
</li>
225 A sample configuration file is shown below.
229 mountpoint=/mnt/neuros
230 recordingdir=/home/stan/music/recordings
231 neuros_musicdir=MUSIC
240 <h3>Allowed Keys
</h3>
244 <dd>The directory where the Neuros is mounted.
</dd>
246 <dt>recordingdir
</dt>
247 <dd>The directory where recordings on the Neuros are copied to during
248 synchronziation.
</dd>
250 <dt>neuros_musicdir
</dt>
251 <dd>The subdirectory on the Neuros (inside the mountpoint) where music
252 files are copied to by default. This is used both by the add and by
253 the sync command as the default destination. The default value for
254 this if not specified is
<tt>MUSIC
</tt>.
</dd>
256 <dt>sort_database
</dt>
258 <dd>A boolean key that sets whether the database should be sorted
259 after new entries are added. This affects the display of songs on the
260 Neuros. If this value is set to false, new songs will be shown at the
261 end of lists. Allowed values are
<tt>true
</tt>,
<tt>yes
</tt>,
262 <tt>false
</tt>, or
<tt>no
</tt>.
265 <dt>oggvorbis_support
</dt>
267 <dd>A boolean key that sets whether positron should recognize Ogg
268 Vorbis files as music files. Setting this to
<tt>true
</tt> will allow
269 Ogg Vorbis files to be uploaded to the Neuros.
<em>Warning: If your
270 Neuros does not have a version of the firmware which supports Ogg
271 Vorbis files, DO NOT TURN THIS ON.
</em> This option defaults to
272 <tt>false
</tt>.
</dd> </dl>
276 <dd>A boolean key that sets whether positron should recognize MP3
277 files as music files. Setting this to
<tt>true
</tt> will allow MP3s
278 to be uploaded to the Neuros. You would normally only set this option
279 to
<tt>false
</tt> if your firmware lacks MP3 support for some reason.
280 This option defaults to
<tt>true
</tt>.
</dd> </dl>
287 Zero or more sync blocks are allowed in the configuration file.
288 The sync block defines a syncpoint. Music files are copied from the
289 syncpoint to the specified destination directory on the Neuros. The keys that can appear inside a sync block are:
295 <dd>(Required) The directory on the computer where music files should be copied
296 from. All subdirectories of this directory will also be searched.
</dd>
300 <dd>(Optional) The subdirectory on the Neuros (inside the mountpoint)
301 where music files from
<tt>src
</tt> should be copied. If not
302 specified,
<tt>neuros_musicdir
</tt> will be used by default.
</dd>