summaryrefslogtreecommitdiff
path: root/grecord/doc/C
diff options
context:
space:
mode:
Diffstat (limited to 'grecord/doc/C')
-rw-r--r--grecord/doc/C/figures/grecord_window.pngbin0 -> 16794 bytes
-rw-r--r--grecord/doc/C/legal.xml76
-rw-r--r--grecord/doc/C/mate-sound-recorder.xml259
3 files changed, 335 insertions, 0 deletions
diff --git a/grecord/doc/C/figures/grecord_window.png b/grecord/doc/C/figures/grecord_window.png
new file mode 100644
index 0000000..3cb8fb8
--- /dev/null
+++ b/grecord/doc/C/figures/grecord_window.png
Binary files differ
diff --git a/grecord/doc/C/legal.xml b/grecord/doc/C/legal.xml
new file mode 100644
index 0000000..acb0b40
--- /dev/null
+++ b/grecord/doc/C/legal.xml
@@ -0,0 +1,76 @@
+ <legalnotice id="legalnotice">
+ <para>
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation
+ License (GFDL), Version 1.1 or any later version published
+ by the Free Software Foundation with no Invariant Sections,
+ no Front-Cover Texts, and no Back-Cover Texts. You can find
+ a copy of the GFDL at this <ulink type="help"
+ url="ghelp:fdl">link</ulink> or in the file COPYING-DOCS
+ distributed with this manual.
+ </para>
+ <para> This manual is part of a collection of MATE manuals
+ distributed under the GFDL. If you want to distribute this
+ manual separately from the collection, you can do so by
+ adding a copy of the license to the manual, as described in
+ section 6 of the license.
+ </para>
+
+ <para>
+ Many of the names used by companies to distinguish their
+ products and services are claimed as trademarks. Where those
+ names appear in any MATE documentation, and the members of
+ the MATE Documentation Project are made aware of those
+ trademarks, then the names are in capital letters or initial
+ capital letters.
+ </para>
+
+ <para>
+ DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED
+ UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE
+ WITH THE FURTHER UNDERSTANDING THAT:
+
+ <orderedlist>
+ <listitem>
+ <para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS,
+ WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
+ IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES
+ THAT THE DOCUMENT OR MODIFIED VERSION OF THE
+ DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR
+ A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE
+ RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE
+ OF THE DOCUMENT OR MODIFIED VERSION OF THE
+ DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR
+ MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT,
+ YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY
+ CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY
+ SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER
+ OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
+ LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED
+ VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER
+ EXCEPT UNDER THIS DISCLAIMER; AND
+ </para>
+ </listitem>
+ <listitem>
+ <para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL
+ THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE),
+ CONTRACT, OR OTHERWISE, SHALL THE AUTHOR,
+ INITIAL WRITER, ANY CONTRIBUTOR, OR ANY
+ DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION
+ OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH
+ PARTIES, BE LIABLE TO ANY PERSON FOR ANY
+ DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR
+ CONSEQUENTIAL DAMAGES OF ANY CHARACTER
+ INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS
+ OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR
+ MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR
+ LOSSES ARISING OUT OF OR RELATING TO USE OF THE
+ DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT,
+ EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF
+ THE POSSIBILITY OF SUCH DAMAGES.
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ </legalnotice>
+
diff --git a/grecord/doc/C/mate-sound-recorder.xml b/grecord/doc/C/mate-sound-recorder.xml
new file mode 100644
index 0000000..dba1fe9
--- /dev/null
+++ b/grecord/doc/C/mate-sound-recorder.xml
@@ -0,0 +1,259 @@
+<?xml version="1.0"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+ <!ENTITY legal SYSTEM "legal.xml">
+ <!ENTITY appversion "2.5.2">
+ <!ENTITY manrevision "2.5">
+ <!ENTITY date "February 2004">
+ <!ENTITY app "Sound Recorder">
+ <!ENTITY ug "MATE Desktop User Guide">
+]>
+<!--
+ (Do not remove this comment block.)
+ Maintained by the MATE Documentation Project
+ http://developer.mate.org/projects/gdp
+ Template version: 2.0 beta
+ Template last modified Apr 11, 2002
+
+-->
+<!-- =============Document Header ============================= -->
+<article id="index" lang="en">
+<!-- please do not change the id; for translations, change lang to -->
+<!-- appropriate code -->
+ <articleinfo>
+ <title>&app; Manual V&manrevision;</title>
+
+ <copyright>
+ <year>2002</year>
+ <year>2003</year>
+ <year>2004</year>
+ <holder>Sun Microsystems</holder>
+ </copyright>
+
+<!-- translators: uncomment this:
+
+ <copyright>
+ <year>2003</year>
+ <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
+ </copyright>
+
+ -->
+ <abstract role="description">
+ <para>&app; is a simple application to record and play different sound files</para>
+ </abstract>
+
+ <publisher>
+ <publishername> MATE Documentation Project </publishername>
+ </publisher>
+
+ &legal;
+
+ <authorgroup>
+ <author role="maintainer">
+ <firstname>Sun</firstname>
+ <surname>MATE Documentation Team</surname>
+ <affiliation>
+ <orgname>Sun Microsystems</orgname>
+ <address></address>
+ </affiliation>
+ </author>
+
+<!-- This is appropriate place for other contributors: translators,
+ maintainers, etc. Commented out by default.
+ <othercredit role="translator">
+ <firstname>Latin</firstname>
+ <surname>Translator 1</surname>
+ <affiliation>
+ <orgname>Latin Translation Team</orgname>
+ <address> <email>[email protected]</email> </address>
+ </affiliation>
+ <contrib>Latin translation</contrib>
+ </othercredit>
+-->
+ </authorgroup>
+
+ <revhistory>
+ <revision>
+ <revnumber>&app; Manual V&manrevision;</revnumber>
+ <date>&date;</date>
+ <revdescription>
+ <para role="author">Sun MATE Documentation Team</para>
+ <para role="publisher">MATE Documentation Project</para>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>Sound Recorder Manual V2.4</revnumber>
+ <date>September 2003</date>
+ <revdescription>
+ <para role="author">Sun MATE Documentation Team</para>
+ <para role="publisher">MATE Documentation Project</para>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>Sound Recorder Manual V2.3</revnumber>
+ <date>January 2003</date>
+ <revdescription>
+ <para role="author">Sun MATE Documentation Team</para>
+ <para role="publisher">MATE Documentation Project</para>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>Sound Recorder Manual V2.2</revnumber>
+ <date>August 2002</date>
+ <revdescription>
+ <para role="author">Sun MATE Documentation Team</para>
+ <para role="publisher">MATE Documentation Project</para>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>Sound Recorder Manual V2.1</revnumber>
+ <date>June 2002</date>
+ <revdescription>
+ <para role="author">Sun MATE Documentation Team</para>
+ <para role="publisher">MATE Documentation Project</para>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>Sound Recorder Manual V2.0</revnumber>
+ <date>May 2002</date>
+ <revdescription>
+ <para role="author">Sun MATE Documentation Team</para>
+ <para role="publisher">MATE Documentation Project</para>
+ </revdescription>
+ </revision>
+ </revhistory>
+
+ <releaseinfo>This manual describes version &appversion; of &app;.
+ </releaseinfo>
+ <legalnotice>
+ <title>Feedback</title>
+ <para>To report a bug or make a suggestion regarding the &app; application or this manual, follow the directions in the <ulink url="ghelp:mate-feedback" type="help">MATE Feedback Page</ulink>.
+ </para>
+<!-- Translators may also add here feedback address for translations -->
+ </legalnotice>
+ </articleinfo>
+
+ <indexterm>
+ <primary>Sound Recorder</primary>
+ </indexterm>
+
+<!-- ============= Document Body ============================= -->
+<!-- ============= Introduction ============================== -->
+
+ <sect1 id="grecord-introduction">
+ <title>Introduction</title>
+ <para>The <application>&app;</application> application enables you
+ to record and play <filename>.flac</filename>, <filename>.ogg</filename>
+ (OGG audio, or <filename>.oga</filename>), and <filename>.wav</filename>
+ sound files.</para>
+ </sect1>
+
+ <sect1 id="grecord-getting-started">
+ <title>Getting Started</title>
+
+ <para>You can start <application>&app;</application> in the following ways:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><guilabel>Application</guilabel> menu</term>
+ <listitem>
+ <para>Choose <menuchoice><guisubmenu>Multimedia</guisubmenu><guimenuitem>Sound Recorder</guimenuitem></menuchoice>. </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Command line</term>
+ <listitem>
+ <para>Execute the following command: <command>mate-sound-recorder</command></para>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>When you start <application>&app;</application>, the following window is displayed.</para>
+
+ <!-- ==== Figure ==== -->
+ <figure id="grecord-fig">
+ <title>&app; Window</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/grecord_window.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Shows &app; main window. Contains menubar, toolbar, progress bar, and statusbar. </phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <!-- ==== End of Figure ==== -->
+
+ </sect1>
+
+<!-- ================ Usage ================================ -->
+
+ <sect1 id="grecord-usage">
+ <title>Usage</title>
+
+ <sect2 id="grecord-record">
+ <title>To Start a New Recording</title>
+ <para>To start a new recording session, perform the following steps:</para>
+ <orderedlist>
+ <listitem><para>Choose <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice>.</para></listitem>
+ <listitem><para>Use the <guilabel>Record as</guilabel> drop-down list to select one of the following recording options: </para>
+ <itemizedlist>
+ <listitem>
+ <para><guilabel>CD Quality, Lossless</guilabel></para>
+ </listitem>
+ <listitem>
+ <para><guilabel>CD Quality, Lossy</guilabel></para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Voice</guilabel></para>
+ </listitem>
+ </itemizedlist>
+</listitem>
+ <listitem><para>To start recording, choose <menuchoice><guimenu>Control</guimenu><guimenuitem>Record</guimenuitem></menuchoice>.</para></listitem>
+ <listitem><para>To stop recording, choose <menuchoice><guimenu>Control</guimenu><guimenuitem>Stop</guimenuitem></menuchoice>.</para></listitem>
+ <listitem><para>To play back the recording, choose <menuchoice><guimenu>Control</guimenu><guimenuitem>Play</guimenuitem></menuchoice>.</para></listitem>
+ <listitem><para>To run the audio mixer, choose <menuchoice><guimenu>File</guimenu>
+ <guimenuitem>Open Volume Control</guimenuitem>
+ </menuchoice>.</para></listitem>
+ <listitem><para>To save the recording, choose <menuchoice><guimenu>File</guimenu><guimenuitem>Save As</guimenuitem></menuchoice>, then type a name for the sound file.</para></listitem>
+ </orderedlist>
+ </sect2>
+
+ <sect2 id="grecord-play">
+ <title>To Play a Sound File</title>
+ <para>To play a sound file, choose <menuchoice><guimenu>File</guimenu><guimenuitem>Open</guimenuitem></menuchoice>. Select a sound file in the <guilabel>Open a file</guilabel> dialog, then click <guibutton>OK</guibutton>. <application>&app;</application> displays the duration of the file in minutes and seconds below the progress bar. To play the file, choose <menuchoice><guimenu>Control</guimenu> <guimenuitem>Play</guimenuitem></menuchoice>. The progress indicator moves along the progress bar as the sound file is playing. </para>
+ </sect2>
+
+ <sect2 id="grecord-props">
+ <title>To Display the Properties of a File</title>
+ <para>To display the properties of a file, choose
+ <menuchoice><guimenu>File</guimenu><guimenuitem>File Information</guimenuitem></menuchoice>. <application>&app;</application> displays the following information about the file:</para>
+ <variablelist>
+ <varlistentry>
+ <term><guilabel>File Information</guilabel></term>
+ <listitem>
+ <para><guilabel>Folder</guilabel> displays the name of the folder in which the file is located.</para>
+ <para><guilabel>Filename</guilabel> displays the name of the file.</para>
+ <para><guilabel>File size</guilabel> displays the size of the file.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Audio Information</guilabel></term>
+ <listitem>
+ <para><guilabel>Song length</guilabel> displays the length of the audio data in the file.</para>
+ <para><guilabel>Number of channels</guilabel> displays the number of channels on which the audio data was recorded.</para>
+ <para><guilabel>Sample rate</guilabel> displays the sample rate at which the audio data was recorded.</para>
+ <para><guilabel>Bit rate</guilabel> displays the bit rate at which the audio data was recorded.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ </sect2>
+
+ </sect1>
+
+</article>