/usr/share/doc/copyq/html/scripting.html is in copyq-doc 3.2.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 | <!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>Scripting — CopyQ documentation</title>
<link rel="shortcut icon" href="_static/icon_32x32.png"/>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="CopyQ documentation" href="index.html"/>
<link rel="next" title="Command Examples" href="command-examples.html"/>
<link rel="prev" title="Writing Commands and Adding Functionality" href="writing-commands-and-adding-functionality.html"/>
<script src="_static/js/modernizr.min.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">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> CopyQ
<img src="_static/icon_64x64.png" class="logo" />
</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" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">The Basics</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="basic-usage.html">Basic Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="tabs-and-items.html">Tabs and Items</a></li>
<li class="toctree-l1"><a class="reference internal" href="keyboard.html">Keyboard</a></li>
<li class="toctree-l1"><a class="reference internal" href="images.html">Images</a></li>
<li class="toctree-l1"><a class="reference internal" href="tags.html">Tags</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ - Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
</ul>
<p class="caption"><span class="caption-text">Advanced Topics</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="command-line.html">Command Line</a></li>
<li class="toctree-l1"><a class="reference internal" href="sessions.html">Sessions</a></li>
<li class="toctree-l1"><a class="reference internal" href="pin-items.html">Pin Items</a></li>
<li class="toctree-l1"><a class="reference internal" href="password-protection.html">Password Protection</a></li>
<li class="toctree-l1"><a class="reference internal" href="synchronize.html">Synchronize with Documents</a></li>
<li class="toctree-l1"><a class="reference internal" href="writing-commands-and-adding-functionality.html">Writing Commands and Adding Functionality</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Scripting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#searching-items">Searching Items</a></li>
<li class="toctree-l2"><a class="reference internal" href="#working-with-tabs">Working with Tabs</a></li>
<li class="toctree-l2"><a class="reference internal" href="#scripting-functions">Scripting Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="command-examples.html">Command Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="backup.html">Backup</a></li>
<li class="toctree-l1"><a class="reference internal" href="writing-raw-data.html">Writing Raw Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="scripting-api.html">Scripting API</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="build-source-code.html">Build from Source Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="fixing-bugs.html">Fixing Bugs and Adding Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="source-code-overview.html">Source Code Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="translations.html">Translations</a></li>
<li class="toctree-l1"><a class="reference internal" href="text-encoding.html">Text Encoding</a></li>
<li class="toctree-l1"><a class="reference internal" href="customize-and-build-the-windows-installer.html">Customize and Build the Windows Installer</a></li>
</ul>
</div>
</div>
</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="index.html">CopyQ</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="index.html">Docs</a> »</li>
<li>Scripting</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/scripting.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="scripting">
<h1>Scripting<a class="headerlink" href="#scripting" title="Permalink to this headline">¶</a></h1>
<p>If you need to process items in some non-trivial way you can take
advantage of the scripting interface the application provides. This is
accessible on command line as <code class="docutils literal"><span class="pre">copyq</span> <span class="pre">eval</span> <span class="pre">SCRIPT</span></code> or
<code class="docutils literal"><span class="pre">copyq</span> <span class="pre">-e</span> <span class="pre">SCRIPT</span></code> where <code class="docutils literal"><span class="pre">SCRIPT</span></code> is string containing commands
written in Javascript-similar scripting language (Qt Script with is
ECMAScript scripting language).</p>
<p>Every command line option is available as function in the scripting
interface. Command <code class="docutils literal"><span class="pre">copyq</span> <span class="pre">help</span> <span class="pre">tab</span></code> can be written as
<code class="docutils literal"><span class="pre">copyq</span> <span class="pre">eval</span> <span class="pre">'print(help("tab"))'</span></code> (note: <code class="docutils literal"><span class="pre">print</span></code> is needed to print
the return value of <code class="docutils literal"><span class="pre">help("tab")</span></code> function call).</p>
<div class="section" id="searching-items">
<h2>Searching Items<a class="headerlink" href="#searching-items" title="Permalink to this headline">¶</a></h2>
<p>You can print each item with <code class="docutils literal"><span class="pre">copyq</span> <span class="pre">read</span> <span class="pre">N</span></code> where N is item number
from 0 to <code class="docutils literal"><span class="pre">copyq</span> <span class="pre">size</span></code> (i.e. number of items in the first tab) and put
item to clipboard with <code class="docutils literal"><span class="pre">copyq</span> <span class="pre">select</span> <span class="pre">N</span></code>. With these commands it’s
possible to search items and copy the right one with a script. E.g.
having file <code class="docutils literal"><span class="pre">script.js</span></code> containing</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">var</span> <span class="n">match</span> <span class="o">=</span> <span class="s2">"MATCH-THIS"</span><span class="p">;</span>
<span class="n">var</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
<span class="k">while</span> <span class="p">(</span><span class="n">i</span> <span class="o"><</span> <span class="n">size</span><span class="p">()</span> <span class="o">&&</span> <span class="nb">str</span><span class="p">(</span><span class="n">read</span><span class="p">(</span><span class="n">i</span><span class="p">))</span><span class="o">.</span><span class="n">indexOf</span><span class="p">(</span><span class="n">match</span><span class="p">)</span> <span class="o">===</span> <span class="o">-</span><span class="mi">1</span><span class="p">)</span>
<span class="o">++</span><span class="n">i</span><span class="p">;</span>
<span class="n">select</span><span class="p">(</span><span class="n">i</span><span class="p">);</span>
</pre></div>
</div>
<p>and passing it to CopyQ using <code class="docutils literal"><span class="pre">cat</span> <span class="pre">script.js</span> <span class="pre">|</span> <span class="pre">copyq</span> <span class="pre">eval</span> <span class="pre">-</span></code> will put
first item containing “MATCH-THIS” string to clipboard.</p>
</div>
<div class="section" id="working-with-tabs">
<h2>Working with Tabs<a class="headerlink" href="#working-with-tabs" title="Permalink to this headline">¶</a></h2>
<p>By default commands and functions work with items in the first tab.
Calling <code class="docutils literal"><span class="pre">read(0,</span> <span class="pre">1,</span> <span class="pre">2)</span></code> will read first three items from the first
tab. To access items in other tab you need to switch the current tab
with <code class="docutils literal"><span class="pre">tab("TAB_NAME")</span></code> (or <code class="docutils literal"><span class="pre">copyq</span> <span class="pre">tab</span> <span class="pre">TAB_NAME</span></code> on command line)
where <code class="docutils literal"><span class="pre">TAB_NAME</span></code> is name of the tab.</p>
<p>For example to search for an item as in the previous script but in all
tabs you’ll have to run:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">var</span> <span class="n">match</span> <span class="o">=</span> <span class="s2">"MATCH-THIS"</span><span class="p">;</span>
<span class="n">var</span> <span class="n">tabs</span> <span class="o">=</span> <span class="n">tab</span><span class="p">();</span>
<span class="k">for</span> <span class="p">(</span><span class="n">var</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">tabs</span><span class="p">)</span> <span class="p">{</span>
<span class="n">tab</span><span class="p">(</span><span class="n">tabs</span><span class="p">[</span><span class="n">i</span><span class="p">]);</span>
<span class="n">var</span> <span class="n">j</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
<span class="k">while</span> <span class="p">(</span><span class="n">j</span> <span class="o"><</span> <span class="n">size</span><span class="p">()</span> <span class="o">&&</span> <span class="nb">str</span><span class="p">(</span><span class="n">read</span><span class="p">(</span><span class="n">j</span><span class="p">))</span><span class="o">.</span><span class="n">indexOf</span><span class="p">(</span><span class="n">match</span><span class="p">)</span> <span class="o">===</span> <span class="o">-</span><span class="mi">1</span><span class="p">)</span>
<span class="o">++</span><span class="n">j</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="n">j</span> <span class="o"><</span> <span class="n">size</span><span class="p">())</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">"Match in tab </span><span class="se">\"</span><span class="s2">"</span> <span class="o">+</span> <span class="n">tabs</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\"</span><span class="s2"> item number "</span> <span class="o">+</span> <span class="n">j</span> <span class="o">+</span> <span class="s2">".</span><span class="se">\n</span><span class="s2">"</span><span class="p">);</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="scripting-functions">
<h2>Scripting Functions<a class="headerlink" href="#scripting-functions" title="Permalink to this headline">¶</a></h2>
<p>As mentioned above, all command line options are also available for
scripting e.g.: <code class="docutils literal"><span class="pre">show()</span></code>, <code class="docutils literal"><span class="pre">hide()</span></code>, <code class="docutils literal"><span class="pre">toggle()</span></code>, <code class="docutils literal"><span class="pre">copy()</span></code>,
<code class="docutils literal"><span class="pre">paste()</span></code>.</p>
<p>Reference for available scripting functions can be found at
<a class="reference internal" href="scripting-api.html#scripting-api"><span class="std std-ref">Scripting API</span></a>.</p>
<p>Other supported functions can be found at <a class="reference external" href="http://doc.qt.io/qt-5/ecmascript.html">ECMAScript
Reference</a>.</p>
</div>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="command-examples.html" class="btn btn-neutral float-right" title="Command Examples" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="writing-commands-and-adding-functionality.html" class="btn btn-neutral" title="Writing Commands and Adding Functionality" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Lukas Holecek.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</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>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|