* added CLI docs to website
This commit is contained in:
Reinhard Pointner
parent
1f0d6be296
commit
1532d14570
|
|
@ -18,18 +18,23 @@ a img {
|
||||||
border: none;
|
border: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
table {
|
table.reference {
|
||||||
border-collapse: collapse;
|
border-collapse: collapse;
|
||||||
}
|
}
|
||||||
|
|
||||||
th, td {
|
table.reference th, table.reference td {
|
||||||
padding: 5px 20px;
|
padding: 5px 20px;
|
||||||
}
|
}
|
||||||
|
|
||||||
td {
|
table.reference td {
|
||||||
border-top: thin dotted lavender;
|
border-top: thin dotted lavender;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
table.reference table td {
|
||||||
|
border-top: none;
|
||||||
|
padding-left: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
.page {
|
.page {
|
||||||
position: relative;
|
position: relative;
|
||||||
margin: 20px auto;
|
margin: 20px auto;
|
||||||
|
|
@ -80,7 +85,7 @@ h1 .description {
|
||||||
.social {
|
.social {
|
||||||
float: right;
|
float: right;
|
||||||
position: relative;
|
position: relative;
|
||||||
right: -25px;
|
right: -10px;
|
||||||
top: -15px;
|
top: -15px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,191 @@
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||||
|
<title>FileBot CLI</title>
|
||||||
|
<link rel="stylesheet" href="base.css" type="text/css" />
|
||||||
|
<link rel="stylesheet" href="code.css" type="text/css" />
|
||||||
|
<link rel="icon" href="favicon.png" />
|
||||||
|
|
||||||
|
<script type="text/javascript">
|
||||||
|
var _gaq = _gaq || [];
|
||||||
|
_gaq.push(['_setAccount', 'UA-25379256-1']);
|
||||||
|
_gaq.push(['_trackPageview']);
|
||||||
|
|
||||||
|
(function() {
|
||||||
|
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
|
||||||
|
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
||||||
|
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
|
||||||
|
})();
|
||||||
|
</script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div class="page">
|
||||||
|
<div class="header">
|
||||||
|
<img class="logo" alt="logo" src="images/icon.png" />
|
||||||
|
<h1>
|
||||||
|
FileBot CLI
|
||||||
|
<span class="description">Command-line interface usage manual</span>
|
||||||
|
</h1>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="content">
|
||||||
|
<div class="screenshot" style="border:none; box-shadow:none; background:white">
|
||||||
|
<img alt="screenshot" src="screenshots/medium/cli.png" />
|
||||||
|
</div>
|
||||||
|
<div class="section about">
|
||||||
|
<h2>About</h2>
|
||||||
|
<p>
|
||||||
|
FileBot can be called with set of command-line arguments directly from the console
|
||||||
|
or in scripts for automation running tasks like renaming
|
||||||
|
tv shows and movies, fetching subtitles or checking sfv files.
|
||||||
|
</p>
|
||||||
|
<h2>Examples</h2>
|
||||||
|
<p>
|
||||||
|
<code><span class="cmd">filebot</span> <span class="option">-rename</span> <span class="argument">path/to/episodes</span></code>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<code><span class="cmd">filebot</span> <span class="option">-rename</span> <span class="argument">"One Piece"</span> <span class="option">--db</span> <span class="argument">anidb</span></code>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<code><span class="cmd">filebot</span> <span class="option">-rename</span> <span class="argument">"Generation Kill"</span> <span class="option">--format</span> <span class="argument">"{n} E{e} [{t}]"</span> <span class="option">-non-strict</span></code>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<code><span class="cmd">filebot</span> <span class="option">-rename</span> <span class="argument">"1x01.avi"</span> <span class="option">--q</span> <span class="argument">"Dexter"</span> <span class="option">--db</span> <span class="argument">thetvdb</span> <span class="option">--lang</span> <span class="argument">de</span></code>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<code><span class="cmd">filebot</span> <span class="option">-rename</span> <span class="argument">"movie.avi"</span> <span class="option">--db</span> <span class="argument">OpenSubtitles</span></code>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<code><span class="cmd">filebot</span> <span class="option">-get-subtitles</span> <span class="argument">path/to/episodes</span></code>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<code><span class="cmd">filebot</span> <span class="option">-get-subtitles</span> <span class="argument">path/to/movie</span> <span class="option">--q</span> <span class="argument">Avatar</span> <span class="option">--lang</span> <span class="argument">zh</span> <span class="option">--output</span> <span class="argument">srt</span> <span class="option">--encoding</span> <span class="argument">utf8</span></code>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<code><span class="cmd">filebot</span> <span class="option">-check</span> <span class="argument">path/to/files</span></code>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<code><span class="cmd">filebot</span> <span class="option">-check</span> <span class="argument">path/to/files</span> <span class="option">--output</span> <span class="argument">checksum.md5</span></code>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<code><span class="cmd">filebot</span> <span class="option">-check</span> <span class="argument">path/to/checksum.md5</span></code>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<h2>
|
||||||
|
Argument Reference
|
||||||
|
<a href="http://filebot.svn.sourceforge.net/viewvc/filebot/trunk/source/net/sourceforge/filebot/cli/ArgumentBean.java?view=markup" class="source" onclick="_gaq.push(['_trackPageview', '/source/ArgumentBean.java'])" target="_blank">source</a>
|
||||||
|
</h2>
|
||||||
|
<table class="reference">
|
||||||
|
<tr>
|
||||||
|
<th>Name</th>
|
||||||
|
<th>Description</th>
|
||||||
|
<th>Value</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-rename</td>
|
||||||
|
<td>rename episode/movie files</td>
|
||||||
|
<td>media folder or episode/movie file</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>--db</td>
|
||||||
|
<td>episode/movie datasource</td>
|
||||||
|
<td>
|
||||||
|
<table>
|
||||||
|
<tr>
|
||||||
|
<td>TV Series mode: TVRage, AniDB, TheTVDB</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>Movie mode: OpenSubtitles, TheMovieDB</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>--format</td>
|
||||||
|
<td><a href="naming.html">naming scheme</a></td>
|
||||||
|
<td><code st><span class="block start">{</span><span class="variable">n</span><span class="block end">}</span> - <span class="block start">{</span><span class="string">'S'</span>+<span class="variable">s</span>.<span class="method"><span class="method">pad</span></span>(<span class="numeral">2</span>)<span class="block end">}</span>E<span class="block start">{</span><span class="variable">e</span>.<span class="method">pad</span>(<span class="numeral">2</span>)<span class="block end">}</span> - <span class="block start">{</span><span class="variable">t</span><span class="block end">}</span></code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-non-strict</td>
|
||||||
|
<td>use less strict matching</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-get-subtitles</td>
|
||||||
|
<td>fetch subtitles</td>
|
||||||
|
<td>media folder or episode/movie file</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>--q</td>
|
||||||
|
<td>search query</td>
|
||||||
|
<td>tv series or movie title</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>--lang</td>
|
||||||
|
<td><a href="http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">2-letter language code</a></td>
|
||||||
|
<td>en, de, fr, es, ja, zh, etc</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-check</td>
|
||||||
|
<td>create/check verification</td>
|
||||||
|
<td>folder or sfv file</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>--output</td>
|
||||||
|
<td>output format and/or path</td>
|
||||||
|
<td>
|
||||||
|
<table>
|
||||||
|
<tr>
|
||||||
|
<td>-check: sfv, md5, sha1 or checksum filename</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-get-subtitles: srt or subrip</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>--encoding</td>
|
||||||
|
<td>output charset</td>
|
||||||
|
<td>UTF-8, windows-1252, GB18030, etc</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>--log</td>
|
||||||
|
<td>log level</td>
|
||||||
|
<td>all, config, info, warning</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-clear</td>
|
||||||
|
<td>clear cache and settings</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td> -help</td>
|
||||||
|
<td>print help message</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<div class="footer" style="margin-top: 100px">
|
||||||
|
<div id="sflogo">
|
||||||
|
<a href="http://sourceforge.net/projects/filebot">
|
||||||
|
<img src="http://sflogo.sourceforge.net/sflogo.php?group_id=202747&type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" />
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
Hosted on <a href="http://sourceforge.net">sourceforge.net</a>
|
||||||
|
| Creative Commons License: Attribution-NonCommercial-ShareAlike. © 2011
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -26,3 +26,16 @@ code .block {
|
||||||
color: #225577;
|
color: #225577;
|
||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
code .cmd {
|
||||||
|
color: #5C7684;
|
||||||
|
}
|
||||||
|
|
||||||
|
code .option {
|
||||||
|
color: #225577;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
code .argument {
|
||||||
|
color: #008800;
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -7,6 +7,7 @@
|
||||||
<link rel="stylesheet" href="base.css" type="text/css" />
|
<link rel="stylesheet" href="base.css" type="text/css" />
|
||||||
<link rel="icon" href="favicon.png" />
|
<link rel="icon" href="favicon.png" />
|
||||||
|
|
||||||
|
<!-- google analytics -->
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
var _gaq = _gaq || [];
|
var _gaq = _gaq || [];
|
||||||
_gaq.push(['_setAccount', 'UA-25379256-1']);
|
_gaq.push(['_setAccount', 'UA-25379256-1']);
|
||||||
|
|
@ -19,14 +20,30 @@
|
||||||
})();
|
})();
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<!-- Place this tag in your head or just before your close body tag -->
|
<!-- google plus one -->
|
||||||
<script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
|
<script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
|
||||||
|
|
||||||
|
<!-- flattr -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
/* <![CDATA[ */
|
||||||
|
(function() {
|
||||||
|
var s = document.createElement('script'), t = document.getElementsByTagName('script')[0];
|
||||||
|
s.type = 'text/javascript';
|
||||||
|
s.async = true;
|
||||||
|
s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
|
||||||
|
t.parentNode.insertBefore(s, t);
|
||||||
|
})();
|
||||||
|
/* ]]> */
|
||||||
|
</script>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<div class="page">
|
<div class="page">
|
||||||
<div class="social">
|
<div class="social">
|
||||||
<!-- Place this tag where you want the +1 button to render -->
|
<!-- google plus one -->
|
||||||
<g:plusone callback="_gaq.push(['_trackEvent','Social networking','Google Plus One',document.title])"></g:plusone>
|
<g:plusone callback="_gaq.push(['_trackEvent','Social networking','Google Plus One',document.title])"></g:plusone>
|
||||||
|
|
||||||
|
<!-- flattr -->
|
||||||
|
<a onclick="_gaq.push(['_trackEvent','Social networking','flattr',document.title])" class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="http://filebot.sourceforge.net"></a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="header">
|
<div class="header">
|
||||||
|
|
@ -70,7 +87,7 @@
|
||||||
<ul>
|
<ul>
|
||||||
<li>A simple user-interface tuned for drag-n-drop <small class="comment">(no need to bother with file dialogs)</small></li>
|
<li>A simple user-interface tuned for drag-n-drop <small class="comment">(no need to bother with file dialogs)</small></li>
|
||||||
<li>Platform-independent and straight-forward application deployment</li>
|
<li>Platform-independent and straight-forward application deployment</li>
|
||||||
<li>Powerful and full-featured <acronym title="command-line interface">CLI</acronym> for scripts and automation</li>
|
<li>Powerful and full-featured <a href="cli.html"><acronym title="command-line interface">CLI</acronym></a> for <a href="cli.html">scripts and automation</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="next">
|
<ul class="next">
|
||||||
<li>
|
<li>
|
||||||
|
|
|
||||||
|
|
@ -76,7 +76,7 @@
|
||||||
Binding Reference
|
Binding Reference
|
||||||
<a href="http://filebot.svn.sourceforge.net/viewvc/filebot/trunk/source/net/sourceforge/filebot/format/EpisodeBindingBean.java?view=markup" class="source" onclick="_gaq.push(['_trackPageview', '/source/EpisodeBindingBean.java'])" target="_blank">source</a>
|
<a href="http://filebot.svn.sourceforge.net/viewvc/filebot/trunk/source/net/sourceforge/filebot/format/EpisodeBindingBean.java?view=markup" class="source" onclick="_gaq.push(['_trackPageview', '/source/EpisodeBindingBean.java'])" target="_blank">source</a>
|
||||||
</h2>
|
</h2>
|
||||||
<table>
|
<table class="reference">
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th>Name</th>
|
||||||
<th>Description</th>
|
<th>Description</th>
|
||||||
|
|
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 63 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 37 KiB |
Loading…
Reference in New Issue