Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Version bump and documentation update

Version changed to 0.1.0
  • Loading branch information...
commit 89b83a7d49fda84e275770feb5252db92c6c1d5d 1 parent ae2fe84
Blaž Tomažič authored
2  ChangeLog
View
@@ -0,0 +1,2 @@
+Version 0.1.0:
+ - OpenSubtitles support implemented
2  Makefile.am
View
@@ -3,3 +3,5 @@ SUBDIRS = lib submarine doc
dataroot_DATA = COPYING \
COPYING.LESSER
+
+EXTRA_DIST = ChangeLog
44 README.asciidoc
View
@@ -1,10 +1,10 @@
Submarine
===========
Blaž Tomažič <blaz.tomazic@gmail.com>
-0.0.0, 2011-08-09
+0.1.0, 2011-08-11
:Author: Blaž Tomažič
:Email: blaz.tomazic@gmail.com
-:Date: 2011-08-09
+:Date: 2011-08-11
:Revision: 1
== Description
@@ -18,30 +18,52 @@ Blaž Tomažič <blaz.tomazic@gmail.com>
=== Options
--l CODE, --language=CODE::
++-l CODE, --language=CODE+::
Select language to filter subtitles. CODE is a 2 or 3 letter language code (ISO-639-1 and ISO-639-2). Avaliable options can be listed with +-l help+. This option can be specified multiple times. By default, only english (+eng+, +en+) language is selected.
--s CODE, --server=CODE::
++-s CODE, --server=CODE+::
Select server to use for searching subtitles. CODE is a 2 letter server code. Avaliable options can be listed with +-s help+. This option can be specified multiple times. By default, +all+ servers are selected.
--f, --force::
++-f, --force+::
Overwrite all existing subtitle files.
--q, --quiet::
++-q, --quiet+::
Quiet mode. Don't output any messages or warnings.
--v, --verbose::
++-v, --verbose+::
Verbose mode. Output all messages and warnings.
--V, --version::
++-V, --version+::
Display version information and exit.
--h, --help::
++-h, --help+::
Display help message and exit.
+=== Examples
+
+Download a subtitle in Slovenian or Croatian language:
+----
+submarine -l slv -l hr USS_Barracuda.avi
+----
+
+Download subtitles for mutliple files:
+----
+submarine Season01/*.mpg
+----
+
+Download subtitles only from OpenSubtitles:
+----
+submarine -s os Zulu.mkv U-boat.mp4
+----
+
+All together:
+----
+submarine -l slv -l hr -s os USS_Barracuda.avi Season01/*.mpg Zulu.mkv U-boat.mp4
+----
+
== Installation
-Submarine is in early development and has no version releases yet. Therefore it is recommended to use the latest git commit.
+Submarine is developed on and for *GNU/Linux*, although it may work on other Unix platforms.
=== Dependecies
@@ -85,4 +107,4 @@ link="https://flattr.com/submit/auto?user_id=blazt&url=http://github.com/blazt/s
== Powered by
This application is based on the following online subtitle services:
-- *OpenSubtitles* (http://www.opensubtitles.org)
+- *OpenSubtitles* (http://www.opensubtitles.org)
2  configure.ac
View
@@ -1,5 +1,5 @@
AC_PREREQ([2.68])
-AC_INIT([submarine], [0.0.0], [blaz.tomazic@gmail.com])
+AC_INIT([submarine], [0.1.0], [blaz.tomazic@gmail.com])
AC_CONFIG_AUX_DIR([build-aux])
AC_CONFIG_MACRO_DIR([m4])
AC_CONFIG_HEADERS([config.h])
49 doc/README.html
View
@@ -715,8 +715,8 @@
<h1>Submarine</h1>
<span id="author">Blaž Tomažič</span><br />
<span id="email"><tt>&lt;<a href="mailto:blaz.tomazic@gmail.com">blaz.tomazic@gmail.com</a>&gt;</tt></span><br />
-<span id="revnumber">version 0.0.0,</span>
-<span id="revdate">2011-08-09</span>
+<span id="revnumber">version 0.1.0,</span>
+<span id="revdate">2011-08-11</span>
</div>
<div id="content">
<div class="sect1">
@@ -736,7 +736,7 @@ <h3 id="_synopsis">Synopsis</h3>
<h3 id="_options">Options</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
--l CODE, --language=CODE
+<tt>-l CODE, --language=CODE</tt>
</dt>
<dd>
<p>
@@ -744,7 +744,7 @@ <h3 id="_options">Options</h3>
</p>
</dd>
<dt class="hdlist1">
--s CODE, --server=CODE
+<tt>-s CODE, --server=CODE</tt>
</dt>
<dd>
<p>
@@ -752,7 +752,7 @@ <h3 id="_options">Options</h3>
</p>
</dd>
<dt class="hdlist1">
--f, --force
+<tt>-f, --force</tt>
</dt>
<dd>
<p>
@@ -760,7 +760,7 @@ <h3 id="_options">Options</h3>
</p>
</dd>
<dt class="hdlist1">
--q, --quiet
+<tt>-q, --quiet</tt>
</dt>
<dd>
<p>
@@ -768,7 +768,7 @@ <h3 id="_options">Options</h3>
</p>
</dd>
<dt class="hdlist1">
--v, --verbose
+<tt>-v, --verbose</tt>
</dt>
<dd>
<p>
@@ -776,7 +776,7 @@ <h3 id="_options">Options</h3>
</p>
</dd>
<dt class="hdlist1">
--V, --version
+<tt>-V, --version</tt>
</dt>
<dd>
<p>
@@ -784,7 +784,7 @@ <h3 id="_options">Options</h3>
</p>
</dd>
<dt class="hdlist1">
--h, --help
+<tt>-h, --help</tt>
</dt>
<dd>
<p>
@@ -793,12 +793,35 @@ <h3 id="_options">Options</h3>
</dd>
</dl></div>
</div>
+<div class="sect2">
+<h3 id="_examples">Examples</h3>
+<div class="paragraph"><p>Download a subtitle in Slovenian or Croatian language:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>submarine -l slv -l hr USS_Barracuda.avi</tt></pre>
+</div></div>
+<div class="paragraph"><p>Download subtitles for mutliple files:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>submarine Season01/*.mpg</tt></pre>
+</div></div>
+<div class="paragraph"><p>Download subtitles only from OpenSubtitles:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>submarine -s os Zulu.mkv U-boat.mp4</tt></pre>
+</div></div>
+<div class="paragraph"><p>All together:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>submarine -l slv -l hr -s os USS_Barracuda.avi Season01/*.mpg Zulu.mkv U-boat.mp4</tt></pre>
+</div></div>
+</div>
</div>
</div>
<div class="sect1">
<h2 id="_installation">Installation</h2>
<div class="sectionbody">
-<div class="paragraph"><p>Submarine is in early development and has no version releases yet. Therefore it is recommended to use the latest git commit.</p></div>
+<div class="paragraph"><p>Submarine is developed on and for <strong>GNU/Linux</strong>, although it may work on other Unix platforms.</p></div>
<div class="sect2">
<h3 id="_dependecies">Dependecies</h3>
<div class="paragraph"><p>Submarine has little dependencies and is really lightweight.</p></div>
@@ -871,7 +894,7 @@ <h2 id="_powered_by">Powered by</h2>
<div class="ulist"><ul>
<li>
<p>
-<strong>OpenSubtitles</strong> (<a href="http://www.opensubtitles.org">http://www.opensubtitles.org</a>)
+<strong>OpenSubtitles</strong> (<a href="http://www.opensubtitles.org">http://www.opensubtitles.org</a>)
</p>
</li>
</ul></div>
@@ -881,8 +904,8 @@ <h2 id="_powered_by">Powered by</h2>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Version 0.0.0<br />
-Last updated 2011-08-09 11:49:48 CEST
+Version 0.1.0<br />
+Last updated 2011-08-11 13:44:29 CEST
</div>
</div>
</body>
6 doc/submarine.man
View
@@ -1,5 +1,5 @@
.\" Manpage for submarine.
-.TH submarine 1 "11 Aug 2011" "0.0.0" "submarine man page"
+.TH submarine 1 "11 Aug 2011" "0.1.0" "submarine man page"
.SH NAME
submarine \- download subtitles
.SH SYNOPSIS
@@ -33,7 +33,7 @@ Display help message and exit.
Download a subtitle in Slovenian or Croatian language:
.RS
.LP
-submarine -l slv -l hrv USS_Barracuda.avi
+submarine -l slv -l hr USS_Barracuda.avi
.LP
.RE
Download subtitles for mutliple files:
@@ -51,7 +51,7 @@ submarine -s os Zulu.mkv U-boat.mp4
All together:
.RS
.LP
-submarine -l slv -l hrv -s os USS_Barracuda.avi Season01/*.mpg Zulu.mkv U-boat.mp4
+submarine -l slv -l hr -s os USS_Barracuda.avi Season01/*.mpg Zulu.mkv U-boat.mp4
.LP
.RE
.SH AUTHOR
Please sign in to comment.
Something went wrong with that request. Please try again.