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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
</head>
<body bgcolor=white>
<table width=100% border=0>
<tr>
<td width="25%" valign=top>
<p>
<h3>Help Sections</h3>
<p>
<ul>
<li><a href="mainwindow.html">Main Window</a>
<li><a href="login.html">Login</a>
<li><a href="config.html">Configuration File</a>
</ul>
<p>
<h3>Create Release</h3>
<ul>
<li><a href="new_release.html">New Release</a>
<li><a href="file_selection.html">File Selection</a>
<li><a href="progress.html">Progress</a>
</ul>
<p>
<h3>Edit Release</h3>
<ul>
<li><a href="edit_release.html">Select Release</a>
<li><a href="edit_release_details.html">Details</a>
<li><a href="edit_release_files.html">File Selection</a>
<li><a href="release_status.html">Edit Release Status</a>
</ul>
<h3>Other</h3>
<ul>
<li><a href="preferences.html">Preferences</a>
<li><a href="news.html">Submit News</a>
<li><a href="freshmeat_setup.html">Freshmeat Setup</a>
<li><a href="freshmeat_release.html">Freshmeat Release</a>
<li><a href="email_setup.html">Email Address Setup</a>
<li><a href="email_announcement.html">Email Announcement</a>
</ul>
</td>
<td width="75%">
<h1>ReleaseForge Configuration File</h1>
As of v0.9.0 ReleaseForge now requires a data directory in order to start. Typically, this
directory is a subdirectory of the user's home directory. Namely, ReleaseForge, by default,
will use $HOME/.releaseforge as it's data directory. <p>
When ReleaseForge is initially launched this directory will be created if it does not already
exist. In the event that ReleaseForge cannot determine the $HOME environment variable the user
has two options:
<ol>
<li>Explicitly set the $HOME environment variable
<li>Supply a data directory parameter on the command line
</ol>
<h2>Setting the $HOME environment variable</h2>
This varies depending on the operating system or shell so it is recommended that you consult
your systems (or shells) documentation for the specific syntax. If you are using the bash
shell then you can set this value accordingly:<p>
$ <i>export HOME=/home/foo</i><br>
$ <i>python releaseforge.py</i><p>
This will result in ReleaseForge creating (if necessary) the directory
<i>/home/foo/.releaseforge</i> and using it to store it's data.
<p>
<h2>Supply the data directory parameter on the command line</h2>
Use the <i>--data</i> flag to specify a data directory to use. This path should be absolute.
For example, to use /home/foo/.releaseforge as your data directory you would launch
ReleaseForge as such:<p>
$ <i>python releaseforge.py --data=/home/foo/.releaseforge</i><p>
As in all cases, this will result in ReleaseForge creating (if necessary) the directory
<i>/home/foo/.releaseforge</i> and using it to store it's data.
<h2>Further configuration</h2>
Once ReleaseForge initially runs successfully, the file releaseforge.cfg will be created (if
it does not already exist) in ReleaseForge's data directory (usually $HOME/.releaseforge).
This initial configuration file will be populated minimally. It is recommended that the user
select <i>Preferences</i> from the <i>Edit</i> menu of ReleaseForge's main window and then edit
their settings accordingly and click <i>Ok</i>. <p>
Please see the <a href="preferences.html">preferences</a> page for further information.
</td>
</tr>
</table>
</body>
</html>
|
