filebot/website/cli.html

304 lines
15 KiB
HTML
Raw Normal View History

2011-11-27 05:32:06 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" itemscope itemtype="http://schema.org/Product">
2011-09-14 23:44:52 +00:00
<head>
2011-11-27 05:32:06 +00:00
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<meta name="keywords" content="rename tv series, rename episode, rename movie, download subtitles, file verification, check sfv md5 sha1" />
2011-09-14 23:44:52 +00:00
<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" />
2011-11-27 05:32:06 +00:00
<meta itemprop="name" content="FileBot" />
<meta itemprop="description" content="The ultimate tv renamer / subtitle downloader / sfv validator" />
<meta itemprop="image" content="http://filebot.sourceforge.net/images/icon.png" />
2011-09-17 12:56:49 +00:00
<!-- google analytics -->
2011-09-14 23:44:52 +00:00
<script type="text/javascript">
2011-09-17 12:56:49 +00:00
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-25379256-1']);
_gaq.push(['_trackPageview']);
2011-11-27 05:32:06 +00:00
2011-09-17 12:56:49 +00:00
(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>
2011-11-27 05:32:06 +00:00
<!-- google +1 -->
<script type="text/javascript">
window.___gcfg = {lang: 'en-GB'};
(function() {
var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
po.src = 'https://apis.google.com/js/plusone.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
})();
</script>
2011-09-14 23:44:52 +00:00
</head>
<body>
<div class="page">
2011-11-22 16:12:20 +00:00
<div class="navigation" style="position:absolute; top:36px; right:-40px">
<div>
<ul>
<li><a href="http://filebot.sourceforge.net/forums/">Forums</a></li>
<li><a href="http://filebot.sourceforge.net/forums/viewtopic.php?f=3&t=7">FAQ</a></li>
<li><a href="http://filebot.sourceforge.net/#download">Download</a></li>
</ul>
</div>
</div>
2011-09-17 12:56:49 +00:00
<div class="social">
<div class="twitter" style="position:relative; top:3px;">
<a href="https://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="filebot_renamer" data-url="http://filebot.sourceforge.net/"></a><script type="text/javascript" src="//platform.twitter.com/widgets.js"></script>
2011-09-17 12:56:49 +00:00
</div>
<div class="plusone" style="position:relative; left:25px; top:1px">
<g:plusone callback="_gaq.push(['_trackEvent','Social networking','Google Plus One',document.title])"></g:plusone>
2011-09-17 12:56:49 +00:00
</div>
</div>
2011-09-14 23:44:52 +00:00
<div class="header">
2011-09-17 12:56:49 +00:00
<a href="http://filebot.sourceforge.net"><img class="logo" alt="logo" src="images/icon.png" width="48" height="48" /></a>
2011-09-14 23:44:52 +00:00
<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">
<a target="_blank" href="screenshots/original/cli.png"><img alt="screenshot" src="screenshots/medium/cli.png" /></a>
</div>
2011-09-14 23:44:52 +00:00
<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>
2011-09-22 16:11:00 +00:00
<h2 id="examples">Examples</h2>
<h3 id="rename">Rename</h3>
2011-09-14 23:44:52 +00:00
<p>
<code><span class="cmd">filebot</span> <span class="option">-rename</span> <span class="argument">path/to/episodes</span></code>
2011-09-15 12:46:07 +00:00
Rename given episodes or movies.
2011-09-14 23:44:52 +00:00
</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>
2011-09-15 12:46:07 +00:00
Rename given episodes using AniDB episode info.
2011-09-14 23:44:52 +00:00
</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>
2011-09-15 12:46:07 +00:00
Rename given episodes according to the given format. Enable comprehensive Episode/File matching.
2011-09-14 23:44:52 +00:00
</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>
2011-09-15 12:46:07 +00:00
Rename a single episode forcing the series name. Use German language episode info.
2011-09-14 23:44:52 +00:00
</p>
<p>
2011-09-15 12:46:07 +00:00
<code><span class="cmd">filebot</span> <span class="option">-rename</span> <span class="argument">"movie.avi"</span> <span class="option">-q</span> <span class="argument">Avatar</span> <span class="option">--db</span> <span class="argument">OpenSubtitles</span></code>
Rename a single movie looking up movie info via file hash or using the given movie title.
2011-09-14 23:44:52 +00:00
</p>
<h3 id="subtitles">Fetch Subtitles</h3>
2011-09-14 23:44:52 +00:00
<p>
<code><span class="cmd">filebot</span> <span class="option">-get-missing-subtitles</span> <span class="argument">path/to/episodes</span></code>
Fetch subtitles that are missing for the given files. Lookup matching subtitles via file hash only.
2011-09-14 23:44:52 +00:00
</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>
Fetch subtitles and force output format. Lookup subtitles via file hash or given search query.
2011-09-14 23:44:52 +00:00
</p>
<h3 id="verification">File Verification</h3>
2011-09-14 23:44:52 +00:00
<p>
<code><span class="cmd">filebot</span> <span class="option">-check</span> <span class="argument">path/to/files</span></code>
2011-09-15 12:46:07 +00:00
Compute SFV file and automatically determine output file.
2011-09-14 23:44:52 +00:00
</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>
2011-09-15 12:46:07 +00:00
Compute checksums according to the given output file.
2011-09-14 23:44:52 +00:00
</p>
<p>
<code><span class="cmd">filebot</span> <span class="option">-check</span> <span class="argument">path/to/checksum.md5</span></code>
2011-10-16 14:41:58 +00:00
Check file integrity using the given checksum file.
2011-09-14 23:44:52 +00:00
</p>
<h3 id="scripting">Scripting</h3>
2011-10-16 14:21:38 +00:00
<p>
<code><span class="cmd">filebot</span> <span class="option">-list</span> <span class="option">--db</span> <span class="argument">thetvdb</span> <span class="option">--q</span> <span class="argument">Dexter</span> <span class="option">--format</span> <span class="argument">"{s}x{e.pad(2)} {t}"</span></code>
Fetch episode list and print to console.
</p>
<p>
<code><span class="cmd">filebot</span> <span class="option">-mediainfo</span> <span class="argument">path/to/files</span> <span class="option">--format</span> <span class="argument">"{fn} {resolution} {vc} {af}"</span></code>
Read media info and print to console.
</p>
<p>
<code><span class="cmd">filebot</span> <span class="option">-script</span> <span class="argument">"path/to/script.groovy"</span> <span class="argument">args...</span></code>
2011-11-05 00:43:37 +00:00
Execute a given Groovy script. Find the manual on scripting <a href="script.html">here</a>.
</p>
2011-09-15 12:46:07 +00:00
2011-09-22 16:11:00 +00:00
<h2 class="reference" id="arguments">
2011-09-15 12:46:07 +00:00
Argument Reference
2011-11-05 00:43:37 +00:00
<a href="http://filebot.svn.sourceforge.net/viewvc/filebot/trunk/source/net/sourceforge/filebot/cli/ArgumentBean.java?view=markup" class="source" target="_blank">source</a>
2011-09-15 12:46:07 +00:00
</h2>
2011-09-15 09:51:22 +00:00
<table class="reference cli">
2011-09-17 12:56:49 +00:00
<tr>
<th>Name</th>
<th>Description</th>
<th>Usage</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><a href="naming.html">movie or episode format expression</a></td>
2011-09-17 12:56:49 +00:00
</tr>
<tr>
<td>-get-subtitles</td>
<td>fetch subtitles</td>
<td>media folder or episode/movie file</td>
</tr>
<tr>
<td>-get-missing-subtitles</td>
<td>fetch missing subtitles</td>
<td>media folder or episode/movie file</td>
2011-09-17 12:56:49 +00:00
</tr>
<tr>
<td>--q</td>
<td>search query</td>
<td>tv series or movie title</td>
</tr>
<tr>
<td>--lang</td>
2011-09-22 12:24:10 +00:00
<td><a href="http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank">2-letter language code</a></td>
2011-09-17 12:56:49 +00:00
<td>en, de, fr, es, ja, zh, etc</td>
</tr>
2011-11-25 19:43:24 +00:00
<tr>
<td>-non-strict</td>
<td>use advanced matching</td>
<td>
<table>
<tr>
<td>Rename mode: match multiple tv shows</td>
</tr>
<tr>
<td>Subtitle mode: match subtitles by name</td>
</tr>
</table>
</td>
</tr>
2011-09-17 12:56:49 +00:00
<tr>
<td>-check</td>
<td>create/check verification file</td>
<td>folder or sfv file</td>
</tr>
<tr>
<td>--output</td>
<td>output format and/or path</td>
<td>
<table>
<tr>
<td>Checksum mode: sfv, md5, sha1 or filename</td>
</tr>
<tr>
<td>Subtitle mode: srt <small class="comment">(re-encode subtitles in SubRip format)</small></td>
</tr>
</table>
</td>
</tr>
<tr>
<td>--encoding</td>
<td>output charset</td>
<td>UTF-8, windows-1252, GB18030, etc</td>
</tr>
2011-10-16 14:41:58 +00:00
<tr>
<tr>
<td>-list</td>
<td>print episode list</td>
<td></td>
</tr>
<tr>
<td>-mediainfo</td>
<td>print media info</td>
<td></td>
</tr>
<tr>
<td>-script</td>
<td><a href="script.html">execute script</a></td>
<td></td>
</tr>
2011-09-17 12:56:49 +00:00
<tr>
<td>--log</td>
<td>log level</td>
<td>all, config, info, warning</td>
</tr>
<tr>
<td>-clear</td>
2011-09-22 12:24:10 +00:00
<td>clear cache and preferences</td>
<td></td>
</tr>
<td>-no-analytics</td>
2011-11-16 17:24:14 +00:00
<td>disable analytics</td>
2011-09-17 12:56:49 +00:00
<td></td>
</tr>
<tr>
2011-10-16 14:21:38 +00:00
<td>-help</td>
2011-09-17 12:56:49 +00:00
<td>print help message</td>
<td></td>
</tr>
</table>
</div>
2011-11-16 17:24:14 +00:00
<p class="suggestion">
2011-11-16 17:24:14 +00:00
Need some help getting started? Check the <a href="http://filebot.sourceforge.net/forums/viewforum.php?f=4">forums</a>.
</p>
<div class="metrics">
<script type="text/javascript" src="http://www.ohloh.net/p/16945/widgets/project_partner_badge.js"></script>
</div>
<div class="footer">
<div id="flattr">
<!-- 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>
<a class="FlattrButton" rev="flattr;button:compact;" href="http://filebot.sourceforge.net"></a>
</div>
<div id="donate">
<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline" target="_blank">
<input type="hidden" name="cmd" value="_s-xclick" />
<input type="hidden" name="encrypted" value="-----BEGIN PKCS7-----MIIHNwYJKoZIhvcNAQcEoIIHKDCCByQCAQExggEwMIIBLAIBADCBlDCBjjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQKEwtQYXlQYWwgSW5jLjETMBEGA1UECxQKbGl2ZV9jZXJ0czERMA8GA1UEAxQIbGl2ZV9hcGkxHDAaBgkqhkiG9w0BCQEWDXJlQHBheXBhbC5jb20CAQAwDQYJKoZIhvcNAQEBBQAEgYBOY1pI25A2C4SZ+iVDHkFo19SvO81rJPwLrh+e13RWDAg+qbo4HbMgbyhiAT+rYw+8nD7Iegs7A2IZJ2Fc5B2Z7qBTfAjjin6HbEyuJTdbZUBbosYAiihhutTkSR94tWbNqH9Fpvl502zutMviTRcAy4EGQfTcQP3TQmLZC9cxxTELMAkGBSsOAwIaBQAwgbQGCSqGSIb3DQEHATAUBggqhkiG9w0DBwQIwkN+XtfUJTmAgZDp17/1C1h5m7tGRoMTdffNByh5GElib5j+wWtZQbvAms/t/6y7PGRGNp3Ad7W31caczjF4e4jso5gAxAVlAOyfB1o9xB/IjNoSf/5v6cIByR6TQROIdq+2zUAZ5zSsnnlLX0JjUD+8pHGB3AdsQxmnW5v7i1onpVdB9YYFgriqYNPycDC8cJyzShUR2AJ8fMGgggOHMIIDgzCCAuygAwIBAgIBADANBgkqhkiG9w0BAQUFADCBjjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQKEwtQYXlQYWwgSW5jLjETMBEGA1UECxQKbGl2ZV9jZXJ0czERMA8GA1UEAxQIbGl2ZV9hcGkxHDAaBgkqhkiG9w0BCQEWDXJlQHBheXBhbC5jb20wHhcNMDQwMjEzMTAxMzE1WhcNMzUwMjEzMTAxMzE1WjCBjjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQKEwtQYXlQYWwgSW5jLjETMBEGA1UECxQKbGl2ZV9jZXJ0czERMA8GA1UEAxQIbGl2ZV9hcGkxHDAaBgkqhkiG9w0BCQEWDXJlQHBheXBhbC5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMFHTt38RMxLXJyO2SmS+Ndl72T7oKJ4u4uw+6awntALWh03PewmIJuzbALScsTS4sZoS1fKciBGoh11gIfHzylvkdNe/hJl66/RGqrj5rFb08sAABNTzDTiqqNpJeBsYs/c2aiGozptX2RlnBktH+SUNpAajW724Nv2Wvhif6sFAgMBAAGjge4wgeswHQYDVR0OBBYEFJaffLvGbxe9WT9S1wob7BDWZJRrMIG7BgNVHSMEgbMwgbCAFJaffLvGbxe9WT9S1wob7BDWZJRroYGUpIGRMIGOMQswCQYDVQQGEwJVUzELMAkGA1UECBMCQ0ExFjAUBgNVBAcTDU1vdW50YWluIFZpZXcxFDASBgNVBAoTC1BheVBhbCBJbmMuMRMwEQYDVQQLFApsaXZlX2NlcnRzMREwDwYDVQQDFAhsaXZlX2FwaTEcMBoGCSqGSIb3DQEJARYNcmVAcGF5cGFsLmNvbYIBADAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4GBAIFfOlaagFrl71+jq6OKidbWFSE+Q4FqROvdgIONth+8kSK//Y/4ihuE4Ymvzn5ceE3S/iBSQQMjyvb+s2TWbQYDwcp129OPIbD9epdr4tJOUNiSojw7BHwYRiPh58S1xGlFgHFXwrEBb3dgNbMUa+u4qectsMAXpVHnD9wIyfmHMYIBmjCCAZYCAQEwgZQwgY4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJDQTEWMBQGA1UEBxMNTW91bnRhaW4gVmlldzEUMBIGA1UEChMLUGF5UGFsIEluYy4xEzARBgNVBAsUCmxpdmVfY2VydHMxETAPBgNVBAMUCGxpdmVfYXBpMRwwGgYJKoZIhvcNAQkBFg1yZUBwYXlwYWwuY29tAgEAMAkGBSsOAwIaBQCgXTAYBgkqhkiG9w0BCQMxCwYJKoZIhvcNAQcBMBwGCSqGSIb3DQEJBTEPFw0xMDExMDgwNzE1MjlaMCMGCSqGSIb3DQEJBDEWBBQxOz+EhIKN690rQ57KLzHBZDiMEzANBgkqhkiG9w0BAQEFAASBgCa61dPlT6Y8ZQSkQs8DXuuGFqZhTPVCp6wAx0qyDhNi6rAdPsOQwoBiUEEFz327g7rUn+HcCVBGqEwv4ExMrZThz9ZHROWc9PbAC1dHHtrrA3SInH0HpIZG5RgDhLcgH1agjGbGGv4k/eKr9Bffte3kf6l3Qd92ZX5AUS1Rf/dD-----END PKCS7-----" />
<input onclick="_gaq.push(['_trackPageview', '/donate/paypal'])" type="image" src="images/donate.png" name="submit" alt="PayPal - The safer, easier way to pay online." />
</form>
2011-09-17 12:56:49 +00:00
</div>
Hosted on <a href="http://sourceforge.net">sourceforge.net</a> | Creative Commons License: Attribution-NonCommercial-ShareAlike © 2011
2011-09-14 23:44:52 +00:00
</div>
</div>
</div>
</body>
</html>