Files
clear-linux-documentation/reference/manpages/clr-power-tweaks.conf.5.html
2024-11-04 18:48:51 +00:00

219 lines
13 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>clr-power-tweaks.conf &#8212; Documentation for Clear Linux* project</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=5283bb3d" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
<script src="../../_static/documentation_options.js?v=5929fcd5"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../_static/copybutton.js?v=a56c686a"></script>
<script src="../../_static/bizstyle.js"></script>
<link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/reference/manpages/clr-power-tweaks.conf.5.html" />
<link rel="icon" href="../../_static/favicon.ico"/>
<link rel="author" title="About these documents" href="../../about.html" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="clr_power" href="clr_power.1.html" />
<link rel="prev" title="OS Format" href="os-format.7.html" />
<meta name="viewport" content="width=device-width,initial-scale=1.0" />
<!--[if lt IE 9]>
<script src="_static/css3-mediaqueries.js"></script>
<![endif]-->
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="clr_power.1.html" title="clr_power"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="os-format.7.html" title="OS Format"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Reference</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../man-pages.html" accesskey="U">Man pages</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">clr-power-tweaks.conf</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="clr-power-tweaks-conf">
<h1>clr-power-tweaks.conf<a class="headerlink" href="#clr-power-tweaks-conf" title="Link to this heading"></a></h1>
<dl class="field-list simple">
<dt class="field-odd">Manual section<span class="colon">:</span></dt>
<dd class="field-odd"><p>5</p>
</dd>
</dl>
<section id="synopsis">
<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">clr-power-tweaks.conf</span></code> is an optional configuration file for the
<a class="reference external" href="clr_power.1.html">clr_power(1)</a> utility.</p>
<p><code class="docutils literal notranslate"><span class="pre">/etc/clr-power-tweaks.conf</span></code></p>
</section>
<section id="description">
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Link to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">clr-power-tweaks.conf</span></code> is an optional configuration file for the
<a class="reference external" href="clr_power.1.html">clr_power(1)</a> utility. The configuration file contains kernel and device
parameter values used by the <a class="reference external" href="clr_power.1.html">clr_power(1)</a> utility.</p>
<p>Configuration parameter values placed in <code class="docutils literal notranslate"><span class="pre">clr-power-tweaks.conf</span></code> will
supersede the built-in defaults configured by <a class="reference external" href="clr_power.1.html">clr_power(1)</a>. New
parameters can be added to the configuration to supplement the built-in
values. Built-in parameters can be changed by defining them in
<code class="docutils literal notranslate"><span class="pre">clr-power-tweaks.conf</span></code> with a different value. Parameters can be
excluded from being modified by <a class="reference external" href="clr_power.1.html">clr_power(1)</a> by adding them in
<code class="docutils literal notranslate"><span class="pre">clr-power-tweaks.conf</span></code> without a value.</p>
</section>
<section id="file-format">
<h2>FILE FORMAT<a class="headerlink" href="#file-format" title="Link to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">clr-power-tweaks.conf</span></code> uses a key-value pairs to define parameter
values.</p>
<p>Each line contains one parameter-value pair, delimited by a space
character.</p>
<p>Parameters are paths from the proc(5) filesystem. Parameters paths can
include glob(n) wildcards to match multiple paths.</p>
<p>Acceptable values are determined by the parameter being set. Any
parameter listed in the configuration file without a value will be
excluded by <a class="reference external" href="clr_power.1.html">clr_power(1)</a> and the parameter will inherit the kernels
built-in default parameter value.</p>
</section>
<section id="examples">
<h2>EXAMPLES<a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<ol class="arabic">
<li><p><code class="docutils literal notranslate"><span class="pre">clr-power-tweaks.conf</span></code> entry to override the default value in
<a class="reference external" href="clr_power.1.html">clr_power(1)</a> for CPU governor with <strong>powersave</strong>. All other values
built-in to <a class="reference external" href="clr_power.1.html">clr_power(1)</a> would still get applied.</p>
<p>Note the globbing used with <code class="docutils literal notranslate"><span class="pre">*</span></code> to target all CPU cores.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">/</span><span class="n">sys</span><span class="o">/</span><span class="n">devices</span><span class="o">/</span><span class="n">system</span><span class="o">/</span><span class="n">cpu</span><span class="o">/</span><span class="n">cpu</span><span class="o">*/</span><span class="n">cpufreq</span><span class="o">/</span><span class="n">scaling_governor</span> <span class="n">powersave</span>
</pre></div>
</div>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">clr-power-tweaks.conf</span></code> entry to exclude a parameter causing it to
use the kernels built-in default value (60). All other values
built-in to <a class="reference external" href="clr_power.1.html">clr_power(1)</a> would still get applied.</p>
<p>Note the omission of a value.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">/</span><span class="n">proc</span><span class="o">/</span><span class="n">sys</span><span class="o">/</span><span class="n">vm</span><span class="o">/</span><span class="n">swappiness</span>
</pre></div>
</div>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">clr-power-tweaks.conf</span></code> entry to add two new parameters to increase
UDP buffers All other values built-in to <a class="reference external" href="clr_power.1.html">clr_power(1)</a> would still get
applied.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">/</span><span class="n">proc</span><span class="o">/</span><span class="n">sys</span><span class="o">/</span><span class="n">net</span><span class="o">/</span><span class="n">ipv4</span><span class="o">/</span><span class="n">udp_rmem_min</span> <span class="mi">8192</span>
<span class="o">/</span><span class="n">proc</span><span class="o">/</span><span class="n">sys</span><span class="o">/</span><span class="n">net</span><span class="o">/</span><span class="n">ipv4</span><span class="o">/</span><span class="n">udp_wmem_min</span> <span class="mi">8192</span>
</pre></div>
</div>
</li>
</ol>
</section>
<section id="bugs">
<h2>BUGS<a class="headerlink" href="#bugs" title="Link to this heading"></a></h2>
<p>The default <a class="reference external" href="clr-power-tweaks.conf.5.html">clr-power-tweaks.conf(5)</a> aims to have reasonable defaults
for achieving power and performance efficiency. Default values may not
be optimal for all systems and environments.</p>
<p>See GitHub Issues: <a class="reference external" href="https://github.com/clearlinux/clr-power-tweaks/issues">https://github.com/clearlinux/clr-power-tweaks/issues</a></p>
</section>
<section id="see-also">
<h2>SEE ALSO<a class="headerlink" href="#see-also" title="Link to this heading"></a></h2>
<p><strong>clr_power.conf(5)</strong>, <strong>proc(5)</strong>, <strong>sysctl(2)</strong></p>
<p>For parameters understood by the kernel, please see
<a class="reference external" href="https://www.kernel.org/doc/html/latest/admin-guide/kernel-parameters.html">https://www.kernel.org/doc/html/latest/admin-guide/kernel-parameters.html</a></p>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../index.html">
<img class="logo" src="../../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
</a></p>
<div>
<h3><a href="../../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">clr-power-tweaks.conf</a><ul>
<li><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
<li><a class="reference internal" href="#description">DESCRIPTION</a></li>
<li><a class="reference internal" href="#file-format">FILE FORMAT</a></li>
<li><a class="reference internal" href="#examples">EXAMPLES</a></li>
<li><a class="reference internal" href="#bugs">BUGS</a></li>
<li><a class="reference internal" href="#see-also">SEE ALSO</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="os-format.7.html"
title="previous chapter">OS Format</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="clr_power.1.html"
title="next chapter">clr_power</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/reference/manpages/clr-power-tweaks.conf.5.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="clr_power.1.html" title="clr_power"
>next</a> |</li>
<li class="right" >
<a href="os-format.7.html" title="OS Format"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Reference</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../man-pages.html" >Man pages</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">clr-power-tweaks.conf</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2022 Intel Corporation. All Rights Reserved..
Last updated on Nov 04, 2024.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
</div>
</body>
</html>