Menu
▾
▴
[gst-cvs] rbultje gst-recorder: gst-recorder/ gst-recorder/docs/ gst-recorder/docs/C/ gst-recorder/docs/C/figures/
|
From: Ronald S. B. <rb...@pd...> - 2004-04-10 12:06:11
|
CVS Root: /home/cvs/gstreamer
Module: gst-recorder
Changes by: rbultje
Date: Sat Apr 10 2004 05:06:05 PDT
Log message:
* COPYING-DOCS:
* Makefile.am:
* TODO:
* configure.ac:
* docs/C/Makefile.am:
* docs/C/figures/gst-recorder_druid.png:
* docs/C/figures/gst-recorder_window.png:
* docs/C/gst-recorder-C.omf:
* docs/C/gst-recorder.xml:
* docs/C/legal.xml:
* docs/Makefile.am:
* omf.make:
* xmldocs.make:
Add some docs to help -> contents. Some parts are unfinished, but
so is gst-rec so that doesn't really matter yet...
Modified files:
. : ChangeLog Makefile.am TODO configure.ac
docs : Makefile.am
Added files:
. : COPYING-DOCS omf.make xmldocs.make
docs/C : Makefile.am gst-recorder-C.omf gst-recorder.xml
legal.xml
docs/C/figures : gst-recorder_druid.png gst-recorder_window.png
Links:
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-recorder/COPYING-DOCS?rev=1.1&content-type=text/vnd.viewcvs-markup
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-recorder/ChangeLog.diff?r1=1.23&r2=1.24
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-recorder/Makefile.am.diff?r1=1.7&r2=1.8
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-recorder/TODO.diff?r1=1.32&r2=1.33
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-recorder/configure.ac.diff?r1=1.18&r2=1.19
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-recorder/omf.make?rev=1.1&content-type=text/vnd.viewcvs-markup
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-recorder/xmldocs.make?rev=1.1&content-type=text/vnd.viewcvs-markup
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-recorder/docs/Makefile.am.diff?r1=1.3&r2=1.4
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-recorder/docs/C/Makefile.am?rev=1.1&content-type=text/vnd.viewcvs-markup
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-recorder/docs/C/gst-recorder-C.omf?rev=1.1&content-type=text/vnd.viewcvs-markup
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-recorder/docs/C/gst-recorder.xml?rev=1.1&content-type=text/vnd.viewcvs-markup
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-recorder/docs/C/legal.xml?rev=1.1&content-type=text/vnd.viewcvs-markup
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-recorder/docs/C/figures/gst-recorder_druid.png?rev=1.1&content-type=text/vnd.viewcvs-markup
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-recorder/docs/C/figures/gst-recorder_window.png?rev=1.1&content-type=text/vnd.viewcvs-markup
====Begin Diffs====
--- NEW FILE: COPYING-DOCS ---
GNU Free Documentation License
Version 1.1, March 2000
Copyright (C) 2000 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
0. PREAMBLE
The purpose of this License is to make a manual, textbook, or other
written document "free" in the sense of freedom: to assure everyone
the effective freedom to copy and redistribute it, with or without
modifying it, either commercially or noncommercially. Secondarily,
this License preserves for the author and publisher a way to get
credit for their work, while not being considered responsible for
modifications made by others.
This License is a kind of "copyleft", which means that derivative
works of the document must themselves be free in the same sense. It
complements the GNU General Public License, which is a copyleft
license designed for free software.
We have designed this License in order to use it for manuals for free
software, because free software needs free documentation: a free
program should come with manuals providing the same freedoms that the
software does. But this License is not limited to software manuals;
it can be used for any textual work, regardless of subject matter or
whether it is published as a printed book. We recommend this License
principally for works whose purpose is instruction or reference.
1. APPLICABILITY AND DEFINITIONS
This License applies to any manual or other work that contains a
notice placed by the copyright holder saying it can be distributed
under the terms of this License. The "Document", below, refers to any
such manual or work. Any member of the public is a licensee, and is
addressed as "you".
A "Modified Version" of the Document means any work containing the
Document or a portion of it, either copied verbatim, or with
modifications and/or translated into another language.
A "Secondary Section" is a named appendix or a front-matter section of
the Document that deals exclusively with the relationship of the
publishers or authors of the Document to the Document's overall subject
(or to related matters) and contains nothing that could fall directly
within that overall subject. (For example, if the Document is in part a
textbook of mathematics, a Secondary Section may not explain any
mathematics.) The relationship could be a matter of historical
connection with the subject or with related matters, or of legal,
commercial, philosophical, ethical or political position regarding
them.
The "Invariant Sections" are certain Secondary Sections whose titles
are designated, as being those of Invariant Sections, in the notice
that says that the Document is released under this License.
The "Cover Texts" are certain short passages of text that are listed,
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
the Document is released under this License.
A "Transparent" copy of the Document means a machine-readable copy,
represented in a format whose specification is available to the
general public, whose contents can be viewed and edited directly and
straightforwardly with generic text editors or (for images composed of
pixels) generic paint programs or (for drawings) some widely available
drawing editor, and that is suitable for input to text formatters or
for automatic translation to a variety of formats suitable for input
to text formatters. A copy made in an otherwise Transparent file
format whose markup has been designed to thwart or discourage
subsequent modification by readers is not Transparent. A copy that is
not "Transparent" is called "Opaque".
Examples of suitable formats for Transparent copies include plain
ASCII without markup, Texinfo input format, LaTeX input format, SGML
or XML using a publicly available DTD, and standard-conforming simple
HTML designed for human modification. Opaque formats include
PostScript, PDF, proprietary formats that can be read and edited only
by proprietary word processors, SGML or XML for which the DTD and/or
processing tools are not generally available, and the
machine-generated HTML produced by some word processors for output
purposes only.
The "Title Page" means, for a printed book, the title page itself,
plus such following pages as are needed to hold, legibly, the material
this License requires to appear in the title page. For works in
formats which do not have any title page as such, "Title Page" means
the text near the most prominent appearance of the work's title,
preceding the beginning of the body of the text.
2. VERBATIM COPYING
You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies
to the Document are reproduced in all copies, and that you add no other
conditions whatsoever to those of this License. You may not use
technical measures to obstruct or control the reading or further
copying of the copies you make or distribute. However, you may accept
compensation in exchange for copies. If you distribute a large enough
number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and
you may publicly display copies.
3. COPYING IN QUANTITY
If you publish printed copies of the Document numbering more than 100,
and the Document's license notice requires Cover Texts, you must enclose
the copies in covers that carry, clearly and legibly, all these Cover
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
the back cover. Both covers must also clearly and legibly identify
you as the publisher of these copies. The front cover must present
the full title with all words of the title equally prominent and
visible. You may add other material on the covers in addition.
Copying with changes limited to the covers, as long as they preserve
the title of the Document and satisfy these conditions, can be treated
as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto adjacent
pages.
If you publish or distribute Opaque copies of the Document numbering
more than 100, you must either include a machine-readable Transparent
copy along with each Opaque copy, or state in or with each Opaque copy
a publicly-accessible computer-network location containing a complete
Transparent copy of the Document, free of added material, which the
general network-using public has access to download anonymously at no
charge using public-standard network protocols. If you use the latter
option, you must take reasonably prudent steps, when you begin
distribution of Opaque copies in quantity, to ensure that this
Transparent copy will remain thus accessible at the stated location
until at least one year after the last time you distribute an Opaque
copy (directly or through your agents or retailers) of that edition to
the public.
It is requested, but not required, that you contact the authors of the
Document well before redistributing any large number of copies, to give
them a chance to provide you with an updated version of the Document.
4. MODIFICATIONS
You may copy and distribute a Modified Version of the Document under
the conditions of sections 2 and 3 above, provided that you release
the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution
and modification of the Modified Version to whoever possesses a copy
of it. In addition, you must do these things in the Modified Version:
A. Use in the Title Page (and on the covers, if any) a title distinct
from that of the Document, and from those of previous versions
(which should, if there were any, be listed in the History section
of the Document). You may use the same title as a previous version
if the original publisher of that version gives permission.
B. List on the Title Page, as authors, one or more persons or entities
responsible for authorship of the modifications in the Modified
Version, together with at least five of the principal authors of the
Document (all of its principal authors, if it has less than five).
C. State on the Title page the name of the publisher of the
Modified Version, as the publisher.
D. Preserve all the copyright notices of the Document.
E. Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
F. Include, immediately after the copyright notices, a license notice
giving the public permission to use the Modified Version under the
terms of this License, in the form shown in the Addendum below.
G. Preserve in that license notice the full lists of Invariant Sections
and required Cover Texts given in the Document's license notice.
H. Include an unaltered copy of this License.
I. Preserve the section entitled "History", and its title, and add to
it an item stating at least the title, year, new authors, and
publisher of the Modified Version as given on the Title Page. If
there is no section entitled "History" in the Document, create one
stating the title, year, authors, and publisher of the Document as
given on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.
J. Preserve the network location, if any, given in the Document for
public access to a Transparent copy of the Document, and likewise
the network locations given in the Document for previous versions
it was based on. These may be placed in the "History" section.
You may omit a network location for a work that was published at
least four years before the Document itself, or if the original
publisher of the version it refers to gives permission.
K. In any section entitled "Acknowledgements" or "Dedications",
preserve the section's title, and preserve in the section all the
substance and tone of each of the contributor acknowledgements
and/or dedications given therein.
L. Preserve all the Invariant Sections of the Document,
unaltered in their text and in their titles. Section numbers
or the equivalent are not considered part of the section titles.
M. Delete any section entitled "Endorsements". Such a section
may not be included in the Modified Version.
N. Do not retitle any existing section as "Endorsements"
or to conflict in title with any Invariant Section.
If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no material
copied from the Document, you may at your option designate some or all
of these sections as invariant. To do this, add their titles to the
list of Invariant Sections in the Modified Version's license notice.
These titles must be distinct from any other section titles.
You may add a section entitled "Endorsements", provided it contains
nothing but endorsements of your Modified Version by various
parties--for example, statements of peer review or that the text has
been approved by an organization as the authoritative definition of a
standard.
You may add a passage of up to five words as a Front-Cover Text, and a
passage of up to 25 words as a Back-Cover Text, to the end of the list
of Cover Texts in the Modified Version. Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or
through arrangements made by) any one entity. If the Document already
includes a cover text for the same cover, previously added by you or
by arrangement made by the same entity you are acting on behalf of,
you may not add another; but you may replace the old one, on explicit
permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License
give permission to use their names for publicity for or to assert or
imply endorsement of any Modified Version.
5. COMBINING DOCUMENTS
You may combine the Document with other documents released under this
License, under the terms defined in section 4 above for modified
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and
list them all as Invariant Sections of your combined work in its
license notice.
The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single
copy. If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by
adding at the end of it, in parentheses, the name of the original
author or publisher of that section if known, or else a unique number.
Make the same adjustment to the section titles in the list of
Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections entitled "History"
in the various original documents, forming one section entitled
"History"; likewise combine any sections entitled "Acknowledgements",
and any sections entitled "Dedications". You must delete all sections
entitled "Endorsements."
6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents
released under this License, and replace the individual copies of this
License in the various documents with a single copy that is included in
the collection, provided that you follow the rules of this License for
verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute
it individually under this License, provided you insert a copy of this
License into the extracted document, and follow this License in all
other respects regarding verbatim copying of that document.
7. AGGREGATION WITH INDEPENDENT WORKS
A compilation of the Document or its derivatives with other separate
and independent documents or works, in or on a volume of a storage or
distribution medium, does not as a whole count as a Modified Version
of the Document, provided no compilation copyright is claimed for the
compilation. Such a compilation is called an "aggregate", and this
License does not apply to the other self-contained works thus compiled
with the Document, on account of their being thus compiled, if they
are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these
copies of the Document, then if the Document is less than one quarter
of the entire aggregate, the Document's Cover Texts may be placed on
covers that surround only the Document within the aggregate.
Otherwise they must appear on covers around the whole aggregate.
8. TRANSLATION
Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4.
Replacing Invariant Sections with translations requires special
permission from their copyright holders, but you may include
translations of some or all Invariant Sections in addition to the
original versions of these Invariant Sections. You may include a
translation of this License provided that you also include the
original English version of this License. In case of a disagreement
between the translation and the original English version of this
License, the original English version will prevail.
9. TERMINATION
You may not copy, modify, sublicense, or distribute the Document except
as expressly provided for under this License. Any other attempt to
copy, modify, sublicense or distribute the Document is void, and will
automatically terminate your rights under this License. However,
parties who have received copies, or rights, from you under this
License will not have their licenses terminated so long as such
parties remain in full compliance.
10. FUTURE REVISIONS OF THIS LICENSE
The Free Software Foundation may publish new, revised versions
of the GNU Free Documentation License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns. See
http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number.
If the Document specifies that a particular numbered version of this
License "or any later version" applies to it, you have the option of
following the terms and conditions either of that specified version or
of any later version that has been published (not as a draft) by the
Free Software Foundation. If the Document does not specify a version
number of this License, you may choose any version ever published (not
as a draft) by the Free Software Foundation.
ADDENDUM: How to use this License for your documents
To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and
license notices just after the title page:
Copyright (c) YEAR YOUR NAME.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1
or any later version published by the Free Software Foundation;
with the Invariant Sections being LIST THEIR TITLES, with the
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
A copy of the license is included in the section entitled "GNU
Free Documentation License".
If you have no Invariant Sections, write "with no Invariant Sections"
instead of saying which ones are invariant. If you have no
Front-Cover Texts, write "no Front-Cover Texts" instead of
"Front-Cover Texts being LIST"; likewise for Back-Cover Texts.
If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of
free software license, such as the GNU General Public License,
to permit their use in free software.
Index: ChangeLog
===================================================================
RCS file: /home/cvs/gstreamer/gst-recorder/ChangeLog,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -d -r1.23 -r1.24
--- a/ChangeLog 10 Apr 2004 00:26:53 -0000 1.23
+++ b/ChangeLog 10 Apr 2004 12:05:52 -0000 1.24
@@ -1,3 +1,21 @@
+2004-04-10 Ronald Bultje <rb...@ro...>
+
+ * COPYING-DOCS:
+ * Makefile.am:
+ * TODO:
+ * configure.ac:
+ * docs/C/Makefile.am:
+ * docs/C/figures/gst-recorder_druid.png:
+ * docs/C/figures/gst-recorder_window.png:
+ * docs/C/gst-recorder-C.omf:
+ * docs/C/gst-recorder.xml:
+ * docs/C/legal.xml:
+ * docs/Makefile.am:
+ * omf.make:
+ * xmldocs.make:
+ Add some docs to help -> contents. Some parts are unfinished, but
+ so is gst-rec so that doesn't really matter yet...
2004-04-09 Ronald Bultje <rb...@ro...>
* src/window.c: (cb_allow_overwrite), (create_window):
Index: Makefile.am
RCS file: /home/cvs/gstreamer/gst-recorder/Makefile.am,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- a/Makefile.am 29 Jan 2004 18:29:11 -0000 1.7
+++ b/Makefile.am 10 Apr 2004 12:05:53 -0000 1.8
@@ -13,7 +13,8 @@
EXTRA_DIST = \
gst-recorder.spec gst-recorder.spec.in \
configure.ac autogen.sh \
- $(INTLTOOL_BUILT:=.in)
+ $(INTLTOOL_BUILT:=.in) \
+ omf.make xmldocs.make COPYING-DOCS
DISTCLEANFILES = po/.intltool-merge-cache \
$(INTLTOOL_BUILT)
Index: TODO
RCS file: /home/cvs/gstreamer/gst-recorder/TODO,v
retrieving revision 1.32
retrieving revision 1.33
diff -u -d -r1.32 -r1.33
--- a/TODO 9 Apr 2004 01:06:32 -0000 1.32
+++ b/TODO 10 Apr 2004 12:05:53 -0000 1.33
@@ -1,7 +1,6 @@
HIG/UI/GNOME:
* make record/pause/stop button pushdowns based on pipeline state (?)
action-> menu items become radiobuttons. Maybe via GtkAction?
-* add some help functions to help -> contents and preferences.
features/bugs:
* quality interface.
@@ -53,6 +52,7 @@
#6 0x40a369f0 in exit () from /lib/i686/libc.so.6
#7 0x40a21a6f in __libc_start_main () from /lib/i686/libc.so.6
LADSPA/sine bug?
+ Then again, only when closing using the 'X'. Close via File->Quit works.
* warnings when closing preferences window. Seems like a gtk-2.4.0 bug inside
the GtkComboBox widget...
* on exit, my soundcard sometimes hangs (without obvious reason). Even
Index: configure.ac
RCS file: /home/cvs/gstreamer/gst-recorder/configure.ac,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -d -r1.18 -r1.19
--- a/configure.ac 9 Apr 2004 01:06:32 -0000 1.18
+++ b/configure.ac 10 Apr 2004 12:05:53 -0000 1.19
@@ -115,6 +115,7 @@
data/Makefile
data/gst-recorder.schemas.in
docs/Makefile
+docs/C/Makefile
pixmaps/Makefile
po/Makefile.in
src/Makefile
--- NEW FILE: omf.make ---
#
# No modifications of this Makefile should be necessary.
#
# This file contains the build instructions for installing OMF files. It is
# generally called from the makefiles for particular formats of documentation.
# Note that you must configure your package with --localstatedir=/var/lib
# so that the scrollkeeper-update command below will update the database
# in the standard scrollkeeper directory.
# If it is impossible to configure with --localstatedir=/var/lib, then
# modify the definition of scrollkeeper_localstate_dir so that
# it points to the correct location. Note that you must still use
# $(localstatedir) in this or when people build RPMs it will update
# the real database on their system instead of the one under RPM_BUILD_ROOT.
# Note: This make file is not incorporated into xmldocs.make because, in
# general, there will be other documents install besides XML documents
# and the makefiles for these formats should also include this file.
# About this file:
# This file was taken from scrollkeeper_example2, a package illustrating
# how to install documentation and OMF files for use with ScrollKeeper
# 0.3.x and 0.4.x. For more information, see:
# http://scrollkeeper.sourceforge.net/
# Version: 0.1.2 (last updated: March 20, 2002)
omf_dest_dir=$(datadir)/omf/@PACKAGE@
scrollkeeper_localstate_dir = $(localstatedir)/scrollkeeper
CLEANFILES += *.out
omf: omf_timestamp
omf_timestamp: $(omffile)
-for file in $(omffile); do \
scrollkeeper-preinstall $(docdir)/$(docname).xml $(srcdir)/$$file $$file.out; \
done
touch omf_timestamp
install-data-hook-omf:
$(mkinstalldirs) $(DESTDIR)$(omf_dest_dir)
for file in $(omffile); do \
$(INSTALL_DATA) $$file.out $(DESTDIR)$(omf_dest_dir)/$$file; \
-scrollkeeper-update -p $(scrollkeeper_localstate_dir) -o $(DESTDIR)$(omf_dest_dir)
uninstall-local-omf:
-for file in $(srcdir)/*.omf; do \
basefile=`basename $$file`; \
rm -f $(DESTDIR)$(omf_dest_dir)/$$basefile; \
-rmdir $(DESTDIR)$(omf_dest_dir)
-scrollkeeper-update -p $(scrollkeeper_localstate_dir)
--- NEW FILE: xmldocs.make ---
# To use this template:
# 1) Define: figdir, docname, lang, omffile, and entities in
# your Makefile.am file for each document directory,
# although figdir, omffile, and entities may be empty
# 2) Make sure the Makefile in (1) also includes
# "include $(top_srcdir)/xmldocs.make" and
# "dist-hook: app-dist-hook".
# 3) Optionally define 'entities' to hold xml entities which
# you would also like installed
# 4) Figures must go under $(figdir)/ and be in PNG format
# 5) You should only have one document per directory
# 6) Note that the figure directory, $(figdir)/, should not have its
# own Makefile since this Makefile installs those figures.
# example Makefile.am:
# figdir = figures
# docname = scrollkeeper-manual
# lang = C
# omffile=scrollkeeper-manual-C.omf
# entities = fdl.xml
# include $(top_srcdir)/xmldocs.make
# dist-hook: app-dist-hook
# how to install documentation and OMF files for use with ScrollKeeper
# http://scrollkeeper.sourceforge.net/
# Version: 0.1.2 (last updated: March 20, 2002)
# ************* Begin of section some packagers may need to modify **************
# This variable (docdir) specifies where the documents should be installed.
# This default value should work for most packages.
# docdir = $(datadir)/@PACKAGE@/doc/$(docname)/$(lang)
docdir = $(datadir)/gnome/help/$(docname)/$(lang)
# ************** You should not have to edit below this line *******************
xml_files = $(entities) $(docname).xml
EXTRA_DIST = $(xml_files) $(omffile)
CLEANFILES = omf_timestamp
# If the following file is in a subdir (like help/) you need to add that to the path
include $(top_srcdir)/omf.make
all: omf
$(docname).xml: $(entities)
app-dist-hook:
if test "$(figdir)"; then \
$(mkinstalldirs) $(distdir)/$(figdir); \
for file in $(srcdir)/$(figdir)/*.png; do \
basefile=`echo $$file | sed -e 's,^.*/,,'`; \
$(INSTALL_DATA) $$file $(distdir)/$(figdir)/$$basefile; \
done \
fi
install-data-local: omf
$(mkinstalldirs) $(DESTDIR)$(docdir)
for file in $(xml_files); do \
cp $(srcdir)/$$file $(DESTDIR)$(docdir); \
$(mkinstalldirs) $(DESTDIR)$(docdir)/$(figdir); \
$(INSTALL_DATA) $$file $(DESTDIR)$(docdir)/$(figdir)/$$basefile; \
install-data-hook: install-data-hook-omf
uninstall-local: uninstall-local-doc uninstall-local-omf
uninstall-local-doc:
-if test "$(figdir)"; then \
rm -f $(DESTDIR)$(docdir)/$(figdir)/$$basefile; \
done; \
rmdir $(DESTDIR)$(docdir)/$(figdir); \
-for file in $(xml_files); do \
rm -f $(DESTDIR)$(docdir)/$$file; \
-rmdir $(DESTDIR)$(docdir)
--- NEW FILE: Makefile.am ---
figdir = figures
docname = @PACKAGE@
lang = C
omffile = @PACKAGE@-C.omf
entities = legal.xml
include $(top_srcdir)/xmldocs.make
dist-hook: app-dist-hook
--- NEW FILE: gst-recorder-C.omf ---
<?xml version="1.0" encoding="UTF-8"?>
<omf>
<resource>
<creator>
rb...@gn... (Ronald S. Bultje)
</creator>
<maintainer>
</maintainer>
<title>
GStreamer Recorder v0.0.1
</title>
<date>
2004-04-09
</date>
<version identifier="0.0.1" date="2004-04-09" description="Updated for program version 0.0.1"/>
<subject category="GNOME|Applications|Sound and Video"/>
<description>
User manual for GStreamer Recorder.
</description>
<type>
user's guide
</type>
<format mime="text/xml" dtd="-//OASIS//DTD DocBook XML V4.1.2//EN"/>
<identifier url="gst-recorder.xml"/>
<language code="C"/>
<relation seriesid="3a484c97-82fb-22e7-9f05-970a451ddd48"/>
<rights type="GNU FDL" license.version="1.1" holder="Ronald Bultje"/>
</resource>
</omf>
--- NEW FILE: gst-recorder.xml ---
<?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 "0.0.1">
<!ENTITY manrevision "0.0.1">
<!ENTITY date "9 April 2004">
<!ENTITY app "<application>GStreamer Recorder</application>">
<!ENTITY appname "GStreamer Recorder">
]>
<!--
(Do not remove this comment block.)
Maintained by the GNOME Documentation Project
http://developer.gnome.org/projects/gdp
Template version: 2.0 beta
Template last modified Jan 2, 2002
-->
<article id="index" lang="en">
<articleinfo>
<title>&appname; Manual V&manrevision;</title>
<copyright>
<year>2004</year>
<holder>Ronald Bultje</holder>
</copyright>
<!-- translators: uncomment this:
<copyright>
<year>2004</year>
<holder>ME-THE-TRANSLATOR (Latin translation)</holder>
</copyright>
-->
<publisher>
<publishername>GNOME Documentation Project</publishername>
</publisher>
&legal;
<!-- This file contains link to license for the documentation (GNU FDL), and
other legal stuff such as "NO WARRANTY" statement. Please do not change
any of this. -->
<authorgroup>
<author>
<firstname>Ronald S.</firstname>
<surname>Bultje</surname>
<affiliation>
<orgname>GNOME Documentation Project</orgname>
<address>
<email>rb...@gn...</email>
</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>tra...@gn...</email> </address>
</affiliation>
<contrib>Latin translation</contrib>
</othercredit>
</authorgroup>
<revhistory>
<revision>
<revnumber>&appname; Manual V&manrevision;</revnumber>
<date>&date;</date>
<revdescription>
<para role="author">Ronald S. Bultje
<email>rb...@gn...</email></para>
<para role="publisher">GNOME Documentation Project</para>
</revdescription>
</revision>
</revhistory>
<releaseinfo>
This manual describes version &appversion; of &appname;.
</releaseinfo>
<legalnotice>
<title>Feedback</title>
<para>To report a bug or make a suggestion regarding &appname; or
this manual, follow the directions in the
<ulink url="ghelp:gnome-feedback" type="help">GNOME Feedback Page</ulink>.
</para>
<!-- Translators may also add here feedback address for translations -->
</legalnotice>
</articleinfo>
<indexterm zone="index"><primary>gst-recorder</primary></indexterm>
<indexterm zone="index"><primary>GStreamer Recorder</primary></indexterm>
<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
<sect1 id="section-intro">
<title>Introduction</title>
<para>
&app; is a video/audio capture application; it will read data from
your TV card and/or sound card and will save it to a file in any of
the supported formats.
</para>
</sect1>
<!-- ============= Getting Started =========================== -->
<sect1 id="section-getting-started">
<title>Getting Started</title>
<sect2 id="section-to-start">
<title>To Start &appname;</title>
<para>You can start &app; in the following ways:</para>
<variablelist>
<varlistentry>
<term><guimenu>Applications</guimenu> menu</term>
<listitem>
<para>
Choose <menuchoice><guisubmenu>Multimedia</guisubmenu><guimenuitem>&appname;</guimenuitem></menuchoice>.
</para>
</listitem>
</varlistentry>
<term>Command line</term>
Execute the following command: <command>gst-recorder</command></para>
</variablelist>
</sect2>
<sect2 id="section-when-you-start-first-time">
<title>When You Start &appname; for the first time</title>
<para>
When you start &app; for the first time, a druid will pop up to help
you in configuring your capture set-up, such as which codec you would
like to use and from which devices you would like to capture.
<figure id="druid">
<title>&appname; Druid</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/gst-recorder_druid.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>
Shows the druid that will pop up if you start &appname; for
the first time.
</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
In a series of subsequent questions, you will be asked to select a
video and audio source, video and audio codec and a container format
(also known as <quote>muxer</quote>). The sources will be used to
capture data from, the codecs will be used to compress data and
the container format will be used to store data.
<note>
<para>
To get a detailed overview of all options in the first-time druid,
have a look at <xref linkend="section-prefs"/>. All questions and
options are explained there in detail.
</para>
</note>
<sect2 id="section-when-you-start">
<title>When you start &appname;</title>
After doing the initial configuration, the following window is
displayed:
<figure id="window">
<title>&appname; Window</title>
<imagedata fileref="figures/gst-recorder_window.png" format="PNG"/>
<phrase>Shows &appname;'s main window.</phrase>
The &app; window contains the following elements:
<term>Menubar & Toolbar</term>
The menus on the menubar and the buttons on the toolbar
contain all of the commands that you need to work with &app;.
<term>Video area</term>
Shows a live image of your currently selected video source.
If you start recording, this image will be captured to your
video file.
<term>File selection area</term>
Should be used to select a location that you want to capture to.
<term>Statistics table</term>
Shows statistics of your current capture session. If no capture
session is currently active, all items will be set to zero.
Recording time is the amount of time that you have captured so
far; video frames/audio samples is the amount of video frames
(typically 25 or 30 frames per second) and audio samples
(typically 44100 or 48000 Hz) that you have captured
so far; lost/inserted/deleted frames shows the amount of frames
that were lost during capturing or that were inserted/deleted
in order to keep the output synchronized; free disk space shows
the amount of free disk space left on the partition that you are
capturing to.
<!-- ================ Usage ================================ -->
<sect1 id="section-usage">
<title>Usage</title>
<sect2 id="section-capture">
<title>Capture sessions</title>
A capture session is a single recording to one or more files. During
a single session, the timer will increase. When you stop your session,
the timer and related statistics will be reset to zero. You can
control a single capture session as follows:
<itemizedlist>
<listitem>
<para>
To start the session, press <quote>Record</quote>.
</para>
</listitem>
To stop the session, press <quote>Stop</quote>.
To pause an ongoing session temporarily, press
<quote>Pause</quote>.
</itemizedlist>
<sect2 id="section-image-volume">
<title>To control the video image or audio volume</title>
Click the <menuchoice><guimenu>Balance</guimenu></menuchoice> button
in the Toolbar to adjust image settings (such as brightness, contrast
etc.) or audio settings (such as volume) on your current audio and
video sources.
The displayed options will be the ones supported by your sources,
so your specific setup might show more options or none at all.
<!-- ================ Preferences ================================ -->
<sect1 id="section-prefs">
<title>Preferences</title>
To configure &app;, choose <menuchoice><guimenu>Settings</guimenu><guimenuitem>Preferences</guimenuitem></menuchoice>.
WRITEME
</sect1>
</article>
--- NEW FILE: legal.xml ---
<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 GNOME 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>
Many of the names used by companies to distinguish their
products and services are claimed as trademarks. Where those
names appear in any GNOME documentation, and the members of
the GNOME Documentation Project are made aware of those
trademarks, then the names are in capital letters or initial
capital letters.
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>
<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.
</orderedlist>
</legalnotice>
--- NEW FILE: gst-recorder_druid.png ---
PNG
|
