usage.html

---
layout: default
title: Usage
slug: usage
---
<div class="zd-section">
  <h2 id="download-docsets">Download Docsets</h2>
  <p>After installing Zeal go to <kbd>Tools</kbd> ⟶ <kbd>Docsets</kbd> to browse and download docsets.</p>

  <h2>Search Filters</h2>
  <p>You can limit search results to a specific (or a set of specific) docsets.</p>
  <p>The docset filter and the search query are delimited by a colon character (<code>:</code>).</p>
  <p>Examples:</p>
  <ul>
    <li><code>string</code> will search all docsets for <code>string</code></li>
    <li><code>python:string</code> will search only docsets related to Python for <code>string</code></li>
  </ul>
  <img src="/static/img/search_filter.png" class="img-responsive" alt="Search Filter Examples">
</div>

<div class="zd-section">
  <h2 id="shortcuts">Keyboard Shortcuts</h2>
  <table class="table">
    <thead>
      <tr>
        <th>Command</th>
        <th>Shortcut</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td>Focus Search Bar</td>
        <td><kbd>Ctrl+K</kbd> or <kbd>Ctrl+L</kbd></td>
      </tr>
      <tr>
        <td>Find in page</td>
        <td><kbd>Ctrl+F</kbd> or <kbd>/</kbd></td>
      </tr>
      <tr>
        <td>New Tab</td>
        <td><kbd>Ctrl+T</kbd></td>
      </tr>
      <tr>
        <td>Duplicate Tab</td>
        <td><kbd>Ctrl+Alt+T</kbd></td>
      </tr>
      <tr>
        <td>Close Tab</td>
        <td><kbd>Ctrl+W</kbd> (also <kbd>Ctrl+F4</kbd> on Windows)</td>
      </tr>
      <tr>
        <td>Select Tab 1 to 8</td>
        <td><kbd>Alt+1</kbd> through <kbd>Alt+8</kbd></td>
      </tr>
      <tr>
        <td>Select Last Tab</td>
        <td><kbd>Alt+9</kbd></td>
      </tr>
      <tr>
        <td>Zoom In</td>
        <td><kbd>Ctrl+=</kbd> or <kbd>Ctrl++</kbd></td>
      </tr>
      <tr>
        <td>Zoom Out</td>
        <td><kbd>Ctrl+-</kbd></td>
      </tr>
      <tr>
        <td>Zoom Reset</td>
        <td><kbd>Ctrl+0</kbd></td>
      </tr>
      <tr>
        <td>Hide/show Sidebar</td>
        <td><kbd>Ctrl+B</kbd></td>
      </tr>
      <tr>
        <td>Open Preferences</td>
        <td><kbd>Ctrl+,</kbd></td>
      </tr>
      <tr>
        <td>Quit Zeal</td>
        <td><kbd>Ctrl+Q</kbd></td>
      </tr>
    </tbody>
  </table>
</div>

<div class="zd-section">
  <h2 id="plugins">IDE Plugins</h2>

  <h3>Emacs</h3>

  <p>There is an Emacs package available at <a href="https://github.com/jinzhu/zeal-at-point">https://github.com/jinzhu/zeal-at-point</a>.
  </p>

  <h3>IntelliJ IDEA</h3>

  <p>
    There is an IDEA plugin available at <a href="https://plugins.jetbrains.com/plugin/7351?pr=idea">https://plugins.jetbrains.com/plugin/7351?pr=idea</a>.
  </p>

  <h3>KTextEditor (Kate, KWrite, KDevelop, Kile, etc)</h3>

  <p>
    A plugin for KTextEditor-based editors is available at <a href="https://github.com/g3ar/ZealSearch">https://github.com/g3ar/ZealSearch</a>.
  </p>

  <h3>Sublime Text</h3>

  <p>
    There is a Sublime Text 2/3 package available at <a href="https://github.com/vaanwd/Zeal">https://github.com/vaanwd/Zeal</a>.
  </p>

  <h3>VIM</h3>

  <p>
    There is a Vim plugin available at <a href="https://github.com/KabbAmine/zeavim.vim">https://github.com/KabbAmine/zeavim.vim</a>.
  </p>

  <p>
    Or you can use <a href="https://github.com/keith/investigate.vim">https://github.com/keith/investigate.vim</a>
    with something like this in .vimrc:
  </p>
  <pre><code>let g:investigate_command_for_python = '/usr/bin/zeal ^s'</code></pre>

  <p>A simpler way to integrate with Vim is a simple mapping, like</p>
  <pre><code>:nnoremap gz :!zeal "&lt;cword&gt;"&amp;&lt;CR&gt;&lt;CR&gt;</code></pre>

  <h3>Visual Studio Code</h3>

  <p>
    There is a VSCode plugin available at <a href="https://github.com/deerawan/vscode-dash">https://github.com/deerawan/vscode-dash</a>.
  </p>
</div>