You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
gdns/command_line/index.html

213 lines
6.7 KiB
HTML

9 years ago
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Command line options - gdns</title>
<link rel="shortcut icon" href="../img/favicon.ico">
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script>
// Current page data
var mkdocs_page_name = "Command line options";
</script>
<script src="../js/jquery-2.1.1.min.js"></script>
<script src="../js/modernizr-2.8.3.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> gdns</a>
<div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li>
<li class="toctree-l1 ">
<a class="" href="..">Usage</a>
</li>
<li>
<li>
<li class="toctree-l1 current">
<a class="current" href="./">Command line options</a>
<ul>
<li class="toctree-l3"><a href="#command-line-options">command line options</a></li>
<li><a class="toctree-l4" href="#bind">bind</a></li>
<li><a class="toctree-l4" href="#server">server</a></li>
<li><a class="toctree-l4" href="#upstream">upstream</a></li>
<li><a class="toctree-l4" href="#logfile">logfile</a></li>
<li><a class="toctree-l4" href="#debug">debug</a></li>
<li><a class="toctree-l4" href="#blacklist">blacklist</a></li>
</ul>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../ex_config/">Config example</a>
</li>
<li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">gdns</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> &raquo;</li>
<li>Command line options</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<h1 id="command-line-options">command line options</h1>
<h3 id="bind">bind</h3>
<p>special the addres the dns server listen to</p>
<p>example:
<code>-bind 0.0.0.0:53</code>,
<code>-bind :53</code>,
<code>-bind 127.0.0.1:53</code></p>
<h3 id="server">server</h3>
<p>special a filter file and the upstream dns server to use <br />
format</p>
<p><strong>file_name</strong>,<strong>proto</strong>:<strong>addr</strong>:<strong>port</strong></p>
<p><strong>file_name</strong> is the file name contains the domain list</p>
<p><strong>proto</strong> is the upstream dns server protocol, <code>tcp</code> or <code>udp</code></p>
<p><strong>addr</strong> is the ip address of upstream dns server</p>
<p><strong>port</strong> is the upstream dns server port</p>
<p>this options can special multipe times</p>
<p>example:</p>
<p><code>-server domain1.json:udp:8.8.8.8:53</code>,</p>
<p><code>-server domain1.json:tcp:4.2.2.2:53</code>,</p>
<p><code>-server domin2.json:udp:49.32.34.44:5353</code></p>
<p>see <a href="../ex_config/#filter-file">example filter file</a> </p>
<h3 id="upstream">upstream</h3>
<p>special the default upstream dns server </p>
<p>format</p>
<p><strong>proto</strong>:<strong>addr</strong>:<strong>port</strong></p>
<p><strong>proto</strong> is the upstream dns server protocol, <code>tcp</code> or <code>udp</code></p>
<p><strong>addr</strong> is the ip address of upstream dns server</p>
<p><strong>port</strong> is the upstream dns server port</p>
<p>example:</p>
<p><code>-upstream udp:10.10.1.1:53</code></p>
<h3 id="logfile">logfile</h3>
<p>special the file name the log save to</p>
<p>example:</p>
<p><code>-logfile /var/log/gdns.log</code></p>
<h3 id="debug">debug</h3>
<p>output the debug log or not, default false</p>
<p>this options is only used for debugging</p>
<h3 id="blacklist">blacklist</h3>
<p>special the blacklist file</p>
<p>if the reply dns message contains the ip in the blacklist, the message will be dropped</p>
<p>example:</p>
<p><code>-blacklist fakeip.json</code></p>
<p>see <a href="../ex_config/#blacklist-file">example black list</a></p>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../ex_config/" class="btn btn-neutral float-right" title="Config example"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href=".." class="btn btn-neutral" title="Usage"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<span><a href=".." style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../ex_config/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>