← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gnomeradio/trusty

« back to all changes in this revision

Viewing changes to debian/gnomeradio.sgml

  • Committer: Package Import Robot
  • Author(s): POJAR GEORGE
  • Date: 2013-03-28 12:27:27 UTC
  • Revision ID: package-import@ubuntu.com-20130328122727-un4ajwzsq3ska7t1
Tags: 1.8-2ubuntu9
debian/gnomeradio.sgml: Updated man pages to reflect reality.

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/gnomeradio.sgml
1
1
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
2
 
3
3
  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
4
 
  <!ENTITY dhfirstname "<firstname>Moritz</firstname>">
5
 
  <!ENTITY dhsurname   "<surname>Breit</surname>">
 
4
  <!ENTITY dhfirstname "<firstname>Pojar</firstname>">
 
5
  <!ENTITY dhsurname   "<surname>George</surname>">
6
6
  <!-- Please adjust the date whenever revising the manpage. -->
7
 
  <!ENTITY dhdate      "<date>2005-08-03</date>">
 
7
  <!ENTITY dhdate      "<date>2013-03-28</date>">
8
8
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
9
9
       allowed: see man(7), man(1). -->
10
10
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
11
 
  <!ENTITY dhemail     "<email>mail@mobr.de</email>">
12
 
  <!ENTITY dhusername  "Moritz Breit">
 
11
  <!ENTITY dhemail     "<email>&lt;geoubuntu@gmail.com&gt;</email>">
 
12
  <!ENTITY dhusername  "Pojar George">
13
13
  <!ENTITY dhucpackage "<refentrytitle>GNOMERADIO</refentrytitle>">
14
14
  <!ENTITY dhpackage   "gnomeradio">
15
15
 
28
28
      &dhsurname;
29
29
    </author>
30
30
    <copyright>
31
 
      <year>2005</year>
 
31
      <year>2013</year>
32
32
      <holder>&dhusername;</holder>
33
33
    </copyright>
34
34
    &dhdate;
46
46
  <refsynopsisdiv>
47
47
    <cmdsynopsis>
48
48
      <command>&dhpackage;</command>
49
 
      <arg><option>--help</option></arg>
 
49
      <arg><option><replaceable>option...</replaceable></option></arg>      
50
50
    </cmdsynopsis>
51
51
  </refsynopsisdiv>
52
52
  <refsect1>
58
58
    <para>This manual page was written for the &debian; distribution
59
59
      because the original program does not have a manual page.</para>
60
60
      
61
 
    <para><command>&dhpackage;</command> is a FM-radio tuner for
62
 
     the GNOME desktop.
63
 
     It should work with every FM tuner card that is supported by
64
 
     video4linux.
65
 
     Remote controls are supported via (optional) LIRC-support.
66
 
     Gnomeradio can also record radio using GStreamer.
67
 
    </para>
 
61
    <para><command>&dhpackage;</command> is a FM-radio tuner for the GNOME
 
62
      desktop. It should work with every FM tuner card that is supported by
 
63
      video4linux. Remote controls are supported via (optional) LIRC-support.
 
64
      Gnomeradio can also record radio using GStreamer.</para>
68
65
 
69
66
  </refsect1>
70
67
  <refsect1>
71
68
    <title>OPTIONS</title>
72
69
 
73
 
    <para>These programs follow the usual &gnu; command line syntax,
74
 
      with long options starting with two dashes (`-'). 
75
 
      It has only the standard gtk command line parameters which
76
 
      the help option will show you.</para>
 
70
    <para>This program follows the usual &gnu; command line syntax,
 
71
      with long options starting with two dashes (`-').  A summary of
 
72
      options is included below.</para>
77
73
 
78
74
    <variablelist>
79
75
      <varlistentry>
80
 
        <term><option>-?</option>
81
 
          <option>--help</option>
82
 
        </term>
83
 
        <listitem>
84
 
          <para>Show summary of options.</para>
 
76
        <term><option>-?, -h, --help</option>
 
77
        </term>
 
78
        <listitem>
 
79
          <para>Output help message then quit.</para>
 
80
        </listitem>
 
81
      </varlistentry>
 
82
      <varlistentry>
 
83
        <term><option>--version</option>
 
84
        </term>
 
85
        <listitem>
 
86
          <para>Output version information then quit.</para>
 
87
        </listitem>
 
88
      </varlistentry>
 
89
      <varlistentry>
 
90
        <term><option>--alsa-loopback <replaceable>VALUE</replaceable></option>
 
91
        </term>
 
92
        <listitem>
 
93
          <para>Loopback digital audio from radio device (default: enable). This
 
94
            option will automatically start an audio streaming between the radio
 
95
            device and the audio output device. To disable this feature set
 
96
            <replaceable>VALUE</replaceable> to 0.</para>
 
97
        </listitem>
 
98
      </varlistentry>
 
99
      <varlistentry>
 
100
        <term><option>--alsa-capture <replaceable>DEVICE</replaceable></option>
 
101
        </term>
 
102
        <listitem>
 
103
          <para>Manually specifies an capture device (e.g. hw:1,0) for loopback
 
104
            (default: auto).</para>
 
105
        </listitem>
 
106
      </varlistentry>
 
107
      <varlistentry>
 
108
        <term><option>--alsa-playback <replaceable>DEVICE</replaceable></option>
 
109
        </term>
 
110
        <listitem>
 
111
          <para>Manually specifies an playback device (e.g. hw:0,0) for loopback
 
112
            (default: default).</para>
 
113
        </listitem>
 
114
      </varlistentry>
 
115
      <varlistentry>
 
116
        <term><option>--alsa-latency <replaceable>VALUE</replaceable>
 
117
          </option>
 
118
        </term>
 
119
        <listitem>
 
120
          <para>Manually specifies latency for loopback in ms (default: 500).
 
121
            Latency is not a big problem for radio (no video to sync with), and
 
122
            USB radio devices benefit from a larger default latency.</para>
 
123
        </listitem>
 
124
      </varlistentry>
 
125
      <varlistentry>
 
126
        <term><option>--scan</option>
 
127
        </term>
 
128
        <listitem>
 
129
          <para>Scan for stations.</para>
 
130
        </listitem>
 
131
      </varlistentry>
 
132
      <varlistentry>
 
133
        <term><option>--verbose</option>
 
134
        </term>
 
135
        <listitem>
 
136
          <para>Enable verbose output.</para>
85
137
        </listitem>
86
138
      </varlistentry>
87
139
    </variablelist>
92
144
    <para>This manual page was written by &dhusername; &dhemail; for
93
145
      the &debian; system (but may be used by others). Permission is
94
146
      granted to copy, distribute and/or modify this document under
95
 
      the terms of the &gnu; General Public License, Version 2 any 
 
147
      the terms of the &gnu; General Public License, Version 2 or any
96
148
      later version published by the Free Software Foundation.
97
149
    </para>
98
150
        <para>