/
Files.shtml
157 lines (129 loc) · 5.91 KB
/
Files.shtml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content=
"HTML Tidy for Mac OS X (vers 31 October 2006 - Apple Inc. build 15.17), see www.w3.org">
<!-- Copyright Bob Jacobsen 2008 -->
<title>JMRI: DecoderPro User Guide - Configuration Files</title>
<!-- Style -->
<meta http-equiv="Content-Type" content=
"text/html; charset=us-ascii">
<link rel="stylesheet" type="text/css" href="/css/default.css"
media="screen">
<link rel="stylesheet" type="text/css" href="/css/print.css"
media="print">
<link rel="icon" href="/images/jmri.ico" type="image/png">
<link rel="home" title="Home" href="/"><!-- /Style -->
</head>
<body>
<!--#include virtual="/Header" -->
<div id="mBody">
<!--#include virtual="Sidebar" -->
<div id="mainContent">
<h1>JMRI: DecoderPro User Guide</h1>
<h2>Configuration Files</h2>
<p>This section attempts to explain where DecoderPro
Configuration (settings) Files are stored on your computer
and what information they contain.</p>
<dl>
<dd><a name="location" id="location"></a></dd>
<dt class="left">Configuration File Locations</dt>
<dd class="first">
There are two places where JMRI Configuration Files can
be found:
<ol>
<li>The originally-distributed versions of JMRI
Configuration Files live in an 'xml' directory in the
JMRI application package and its subdirectories. Note
that anything you modify here will be lost when you
update JMRI to a new version.<br>
The JMRI application is installed in your Programs
folder by default.</li>
<li>The user's JMRI Preferences directory and its
subdirectories is also of importance. JMRI looks here
first for any files it needs.<br>
You should put any locally-modified versions of files
here so they don't get overwritten by a JMRI update.
Any files that the program writes to containing local
information, e.g. Roster entries and Panel files, are
also written here.<br>
The default user's Preferences location varies by
computer operating system. Normally, it's located:
<ul>
<li>On a Linux machine, look for a .jmri directory
in your home directory.</li>
<li>On Mac OS X, Preferences are stored in a "JMRI"
folder in the /Users/me/Library/Preferences/
folder.</li>
<li>On Windows, this can be in a number of places
depending on the Windows version you're running and
whether you have multiple users configured. Start
by looking under "Documents" or "User Documents" or
"Users and Documents". You're looking for a folder
called "JMRI".</li>
</ul>
<p>The easiest way to find it is to start a JMRI
program, e.g. DecoderPro or PanelPro, and select
"Locations ..." from the "Help" menu. A special treat
for Windows users: if you go to the Windows Start
Menu, in the JMRI section, you can select
"Preferences" to have it open that directory for
you.</p>
<p>You may set or change the location scripts and
user files in the <a href=
"../../../package/apps/TabbedPreferences.shtml#FileLocations">
Preferences... -> File Locations</a> panel. Note
that changing the "User Files Location" will also
change the default location for Panels, Rosters
etc.</p>
</li>
</ol>
</dd>
<dt class="left">Types of Configuration Files</dt>
<dd>
Inside your JMRI Preferences folder are a number of types
of configuration files used by DecoderPro:
<ul>
<li>Decoder definitions - Stored in the
<strong>decoders</strong> subdirectory, one for any
customized decoder; these define how a specific family
of decoders is configured.</li>
<li>Locomotive configurations - Stored in the
<strong>roster</strong> subdirectory, one for each
Locomotive; these record the specific configuration of
each Locomotive in your Roster.</li>
<li>Programmer definitions - Stored in the
<strong>programmers</strong> subdirectory when you've
used at least one Programmer; these define the formats
for the various programming sheets that are available
in Decoder Pro.</li>
<li>The DecoderPro folder, containing your
profiles.</li>
</ul>
</dd>
<dt class="left">General Configuration Files</dt>
<dd>
There are many more JMRI Configuration Files, some shared
by applications, which live in the user's Preferences
directory:
<ul>
<li><tt>roster.xml</tt> - an index of your
Locomotives</li>
<li><tt>decoderIndex.xml</tt> - an index of the
available decoder definition files. It also contains
the information on which specific decoder model uses
which file, how to identify them, and what options they
implement.</li>
<li><tt>names.xml</tt> - not used during normal
operation, this is a list of the standard Variable
Names for use in programmer definitions.</li>
</ul>
</dd>
</dl>More information about the <a href=
"../../setup/Files.shtml">JMRI Configuration Files</a>
<!--#include virtual="/Footer" -->
</div><!-- closes #mainContent-->
</div><!-- closes #mBody-->
</body>
</html>