~ubuntu-branches/ubuntu/trusty/freeguide/trusty

« back to all changes in this revision

Viewing changes to doc/downinst.xml

  • Committer: Bazaar Package Importer
  • Author(s): Shaun Jackman
  • Date: 2007-09-11 16:52:59 UTC
  • mfrom: (1.2.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070911165259-4r32oke21i1ezbmv
Tags: 0.10.5-1
* New upstream release.
* Update the watch file.
* Change Debian policy to version 3.7.2.2. No changes necessary.
* Add ant-optional to build dependencies. Closes: #441762.

Show diffs side-by-side

added added

removed removed

Lines of Context:
52
52
          ready to start FreeGuide!  Go straight to the
53
53
          <link linkend="userguide">User Guide</link>.</para>
54
54
          
55
 
          <para>In the following replace "<uri>proxy.uni.ac.uk</uri>" with
 
55
          <para>In the following replace "<uri>example.com</uri>" with
56
56
          your proxy server address, and "<parameter>8080</parameter>" with
57
57
          the port it uses. On Windows you can find these out from the
58
58
          "<guimenu>Tools</guimenu>" menu on Internet Explorer by choosing
70
70
            middle of the window. Click the "<guibutton>New</guibutton>"
71
71
            button in the <guilabel>Global Variables</guilabel> section.
72
72
            Variable Name: <varname>http_proxy</varname> Variable Value:
73
 
            <returnvalue>http://proxy.uni.ac.uk:8080</returnvalue> Click
 
73
            <returnvalue>http://example.com:8080</returnvalue> Click
74
74
            <guibutton>OK</guibutton> Click <guibutton>OK</guibutton></para>
75
75
          </section>
76
76
 
78
78
            <title>With Windows 95/98/ME</title>
79
79
 
80
80
            <para>Add a line "<code>set
81
 
            http_proxy=http://proxy.uni.ac.uk:8080</code>" to the file
 
81
            http_proxy=http://example.com:8080</code>" to the file
82
82
            <filename>C:\Autoexec.bat</filename></para>
83
83
 
84
84
            <para><guibutton>Restart</guibutton> your computer.</para>
94
94
 
95
95
          <para>Now change the command to read like this:</para>
96
96
 
97
 
          <para><command>javaw.exe -DproxySet=true -DproxyHost=proxy.uni.ac.uk
 
97
          <para><command>javaw.exe -DproxySet=true -DproxyHost=example.com
98
98
          -DproxyPort=8080 -jar "C:\Program Files\FreeGuide\startup.jar"
99
99
          --doc_directory "C:\Program Files\FreeGuide\doc" --install_directory
100
100
          "C:\Program Files\FreeGuide\"</command></para>
130
130
          </listitem>
131
131
 
132
132
          <listitem>
133
 
            <para><link linkend="downinst.linux.debian">Debian and
134
 
            Ubuntu</link></para>
 
133
            <para><link linkend="downinst.linux.ubuntu">Ubuntu</link></para>
 
134
          </listitem>
 
135
          
 
136
          <listitem>
 
137
            <para><link linkend="downinst.linux.debian">Debian</link></para>
135
138
          </listitem>
136
139
 
137
140
          <listitem>
156
159
        <programlisting>su -c "yum install xmltv"</programlisting>
157
160
        or similar.</para>
158
161
        
 
162
        <para>(If you want to do it the hard way, you can find RPMs (for RedHat
 
163
        and Fedora) at <ulink
 
164
        url="http://atrpms.physik.fu-berlin.de/name/xmltv/">http://atrpms.physik.fu-berlin.de/name/xmltv/</ulink>.)</para>
 
165
 
159
166
        <para>For other RPM-based distros, you should find XMLTV in your
160
167
        favourite package repository (let us know so we can add it here).</para>
161
168
        
162
 
        <para>If you want to do it the hard way, you can find RPMs (for RedHat
163
 
        and Fedora) at <ulink
164
 
        url="http://atrpms.physik.fu-berlin.de/name/xmltv/">http://atrpms.physik.fu-berlin.de/name/xmltv/</ulink>.</para>
165
 
        
166
 
        <para>Now, to download FreeGuide, go to the <ulink
 
169
        <para>Alternatively, to download FreeGuide here, go to the <ulink
167
170
        url="http://sourceforge.net/project/showfiles.php?group_id=35309&amp;package_id=27789">sourceforge
168
171
        download page</ulink>, download the
169
 
        <filename>FreeGuide-xx-noarch.rpm</filename> RPM file and install it
 
172
        <filename>freeguide-xx-noarch.rpm</filename> RPM file and install it
170
173
        like so:</para>
171
174
 
172
 
        <programlisting>su -c "rpm -i FreeGuide-xx-noarch.rpm"</programlisting>
 
175
        <programlisting>su -c "rpm -i freeGuide-xx-noarch.rpm"</programlisting>
173
176
 
174
177
        <para>This will install FreeGuide and put a shortcut to it in the
175
178
        menu.</para>
187
190
        <para>Now <link linkend="downinst.linux.config">configure your
188
191
        system</link>.</para>
189
192
      </section>
190
 
 
 
193
      
 
194
      <section id="downinst.linux.ubuntu">
 
195
        <title>FreeGuide on Ubuntu</title>
 
196
        
 
197
        <para>First, you will need the latest version of XMLTV which you can
 
198
        get by typing:</para>
 
199
        
 
200
        <programlisting>sudo apt-get install xmltv</programlisting>
 
201
        
 
202
        <para>The xmltv package is in the
 
203
        "universe" repository, so ensure that is enabled.</para>
 
204
        
 
205
        <para>If you are using Ubuntu Feisty, freeguide is in the "multiverse"
 
206
        repository, so enable that and type:</para>
 
207
        
 
208
        <programlisting>sudo apt-get install freeguide</programlisting>
 
209
        
 
210
        <para>[If you are using an earlier Ubuntu version, you can download and
 
211
        install the FreeGuide package from <ulink
 
212
        url="http://packages.ubuntu.com/feisty/misc/freeguide">http://packages.ubuntu.com/feisty/misc/freeguide</ulink>.
 
213
        This is a Feisty package, but it should work on any version
 
214
        of Ubuntu (it certainly works on Dapper and Edgy).]</para>
 
215
        
 
216
        <para>You can now run FreeGuide by choosing it from the menu (under
 
217
        "Sound and Video") or alternatively by typing into a terminal:</para>
 
218
 
 
219
        <programlisting>freeguide</programlisting>
 
220
 
 
221
        <para>You'll now need to answer a few questions, and then you're ready
 
222
        to go.</para>
 
223
        
 
224
        <para>Now <link linkend="downinst.linux.config">configure your
 
225
        system</link>.</para>
 
226
        
 
227
      </section>
 
228
      
191
229
      <section id="downinst.linux.debian">
192
 
        <title>FreeGuide on Debian and Ubuntu</title>
 
230
        <title>FreeGuide on Debian</title>
193
231
        
194
232
        <para>First, you will need the latest version of XMLTV which you can
195
233
        get by typing:</para>
196
234
        
197
 
        <programlisting>sudo apt-get install xmltv</programlisting>
198
 
        
199
 
        <para>or just:</para>
200
 
        
201
235
        <programlisting>apt-get install xmltv</programlisting>
202
236
        
203
 
        <para>logged in as root.  On Ubuntu, the xmltv package is in the
204
 
        "universe" repository, so ensure that is enabled.  On Debian,
205
 
        the best version is usually in "unstable".</para>
 
237
        <para>logged in as root.  The latest version of FreeGuide is usually
 
238
        in "unstable", but there are decent versions in "testing" and
 
239
        "stable" too.  Unstall it like so:</para>
 
240
        
 
241
        <programlisting>apt-get install freeguide</programlisting>
206
242
                
207
 
        <para>Now download and install the FreeGuide Debian packages from <ulink
208
 
        url="http://packages.debian.org/freeguide">http://packages.debian.org/freeguide</ulink>.</para>
 
243
        <para>[If you need to get the package manually, download and install
 
244
        it from from <ulink
 
245
        url="http://packages.debian.org/freeguide">http://packages.debian.org/freeguide</ulink>.]</para>
209
246
        
210
247
        <para>You can now run FreeGuide by choosing it from the menu or
211
248
        alternatively by typing into a terminal:</para>
273
310
        
274
311
        <para>Go to the <ulink
275
312
        url="http://sourceforge.net/project/showfiles.php?group_id=35309&amp;package_id=27789">sourceforge
276
 
        download page</ulink> and download 
277
 
        <filename>freeguide-x.y.z-bin.tar.gz</filename>.</para>
 
313
        download page</ulink>.</para>
278
314
        
279
 
        <para>You can either unzip this tarball in <filename>/</filename> as
280
 
        root, or unzip it somewhere else and modify the file 
281
 
        <filename>usr/bin/freeguide</filename> to point at the correct
282
 
        paths.</para>
 
315
        <para>To install FreeGuide in its normal place, download
 
316
        <filename>freeguide-x.y.z-install-bin.tar.gz</filename>, and unzip
 
317
        this tarball in <filename>/</filename> as
 
318
        root.</para>
283
319
        
284
320
        <para>You can now run FreeGuide by typing:</para>
285
321
 
286
322
        <programlisting>freeguide</programlisting>
 
323
        
 
324
        <para>To install FreeGuide in a local directory, download
 
325
        and unzip <filename>freeguide-x.y.z-bin.tar.gz</filename>.</para>
 
326
        
 
327
        <para>You can now run FreeGuide by typing:</para>
 
328
 
 
329
        <programlisting>./freeguide</programlisting>
 
330
        
 
331
        <para>in the directory into which you unzipped the file.</para>
287
332
 
288
333
        <para>You'll now need to answer a few questions, and then you're ready
289
334
        to go.</para>
335
380
          <para>Add 2 lines to the file
336
381
          <filename>~/.bash_profile</filename>:</para>
337
382
 
338
 
          <programlisting><code>export http_proxy=http://proxy.uni.ac.uk:8080
339
 
export FREEGUIDE_OPTS=-DproxySet=true -DproxyHost=http://proxy.uni.ac.uk -DproxyPort=8080</code></programlisting>
 
383
          <programlisting><code>export http_proxy=http://example.com:8080
 
384
export FREEGUIDE_OPTS=-DproxySet=true -DproxyHost=http://example.com -DproxyPort=8080</code></programlisting>
340
385
 
341
 
          <para>Replace "<uri>proxy.uni.ac.uk</uri>" with your proxy server
 
386
          <para>Replace "<uri>example.com</uri>" with your proxy server
342
387
          address, and "<parameter>8080</parameter>" with the port it
343
388
          uses.</para>
344
389
        </section>
345
390
      </section>
346
391
    </section>
 
392
 
 
393
    <section id="downinst.macos">
 
394
      <title>Mac OS X</title>
 
395
 
 
396
      <para>[NOTE: these instructions may be somewhat incomplete.  If you can
 
397
      improve them, please <link linkend="contact">contact us</link> - we
 
398
      will be really grateful.]</para>
 
399
      
 
400
      <para>To use FreeGuide on Mac OS X you need Java and XMLTV.</para>
 
401
 
 
402
      <para>You will need the Java 2
 
403
      Runtime Environment version 1.4 or above: You can check this by
 
404
      typing <command>java -version</command> in a terminal.  Ask on the
 
405
      FreeGuide Users' mailing list (see the
 
406
      <link linkend="contact">Contact</link> page) if you have trouble
 
407
      installing Java.</para>
 
408
      
 
409
      <para>First, you will need to install XMLTV.  We don't have specific
 
410
      instructions available for Mac OS X, but the 
 
411
      <link linkend="downinst.linux.xmltv">Linux XMLTV</link> instructions
 
412
      may help.  Please <link linkend="contact">contact us</link> if you
 
413
      get this working, so we can improve these instructions.</para>
 
414
      
 
415
      <para>Now, download the file <filename>freeguide-x.y.z.dmg</filename>
 
416
      from the <ulink
 
417
  url="http://sourceforge.net/project/showfiles.php?group_id=35309&amp;package_id=27789">sourceforge
 
418
      download page</ulink>.</para>
 
419
      
 
420
      <para>Mount the downloaded .dmg file so you can see what's inside.</para>
 
421
      
 
422
      <para>Drag Freeguide.app from the mounted disk image to the Applications
 
423
      Folder.</para>
 
424
 
 
425
      <para>Double click on Freeguide.app to start the program.  Answer the
 
426
      initial questions you are asked.  Uncheck the "Choose channels" checkbox
 
427
      when you see it.  Click "No" when asked whether you want to download
 
428
      listings.</para>
 
429
 
 
430
      <para>In the menu go to Tools and Options.  Expand the Advanced node,
 
431
      and expand Grabbers.  Click XMLTV.</para>
 
432
 
 
433
      <para>Change the paths to the appropriate tv_grab_* perl scripts  
 
434
      executable in the two text entries, so that they are the full
 
435
      absolute paths.</para>
 
436
      
 
437
      <para>Click Configure to choose your channels, and answer the
 
438
      questions.</para>
 
439
      
 
440
      <para>Click OK, and you should be able to click "Download listings" to
 
441
      download.</para>
 
442
      
 
443
      <para><link linkend="contact">Contact us</link> if you have any problems
 
444
      and we'll try to help you get it working.</para>
 
445
      
 
446
    </section>
347
447
<!--
348
 
    <section id="downinst.macos">
349
 
      <title>Mac OS</title>
350
 
 
351
 
      <para>FIXME</para>
352
 
    </section>
353
 
 
354
448
    <section id="downinst.freebsd">
355
449
      <title>FreeBSD</title>
356
450