mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-17 19:48:31 +02:00
Updated docs from master
This commit is contained in:
Manuel Ebert
parent
af070b1ca3
commit
25e92c8abf
35 changed files with 91 additions and 57 deletions
|
|
@ -7,6 +7,14 @@ Basic Usage
|
|||
|
||||
We intentionally break a convention on command line arguments: all arguments starting with a `single dash` will `filter` your journal before viewing it, and can be combined arbitrarily. Arguments with a `double dash` will control how your journal is displayed or exported and are mutually exclusive (ie. you can only specify one way to display or export your journal at a time).
|
||||
|
||||
Listing Journals
|
||||
----------------
|
||||
|
||||
You can list the journals accessible by jrnl::
|
||||
|
||||
jrnl -ls
|
||||
|
||||
The journals displayed correspond to those specified in the jrnl configuration file.
|
||||
|
||||
Composing Entries
|
||||
-----------------
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Advanced Usage — jrnl 1.7.10 documentation</title>
|
||||
<title>Advanced Usage — jrnl 1.7.12 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.7.10',
|
||||
VERSION: '1.7.12',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
<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>
|
||||
<link rel="top" title="jrnl 1.7.10 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.12 documentation" href="index.html" />
|
||||
<link rel="next" title="FAQ" href="recipes.html" />
|
||||
<link rel="prev" title="Import and Export" href="export.html" />
|
||||
|
||||
|
|
|
|||
BIN
docs/_build/doctrees/environment.pickle
vendored
BIN
docs/_build/doctrees/environment.pickle
vendored
Binary file not shown.
BIN
docs/_build/doctrees/index.doctree
vendored
BIN
docs/_build/doctrees/index.doctree
vendored
Binary file not shown.
BIN
docs/_build/doctrees/usage.doctree
vendored
BIN
docs/_build/doctrees/usage.doctree
vendored
Binary file not shown.
2
docs/_build/html/.buildinfo
vendored
2
docs/_build/html/.buildinfo
vendored
|
|
@ -1,4 +1,4 @@
|
|||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: 31968608e106f71186c2f17ba8ede056
|
||||
config: 0df024a5ead6c37f5d663a99c21a2d3f
|
||||
tags: fbb0d17656682115ca4d033fb2f83ba1
|
||||
|
|
|
|||
8
docs/_build/html/_sources/usage.txt
vendored
8
docs/_build/html/_sources/usage.txt
vendored
|
|
@ -7,6 +7,14 @@ Basic Usage
|
|||
|
||||
We intentionally break a convention on command line arguments: all arguments starting with a `single dash` will `filter` your journal before viewing it, and can be combined arbitrarily. Arguments with a `double dash` will control how your journal is displayed or exported and are mutually exclusive (ie. you can only specify one way to display or export your journal at a time).
|
||||
|
||||
Listing Journals
|
||||
----------------
|
||||
|
||||
You can list the journals accessible by jrnl::
|
||||
|
||||
jrnl -ls
|
||||
|
||||
The journals displayed correspond to those specified in the jrnl configuration file.
|
||||
|
||||
Composing Entries
|
||||
-----------------
|
||||
|
|
|
|||
6
docs/_build/html/advanced.html
vendored
6
docs/_build/html/advanced.html
vendored
|
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Advanced Usage — jrnl 1.7.10 documentation</title>
|
||||
<title>Advanced Usage — jrnl 1.7.12 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.7.10',
|
||||
VERSION: '1.7.12',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
<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>
|
||||
<link rel="top" title="jrnl 1.7.10 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.12 documentation" href="index.html" />
|
||||
<link rel="next" title="FAQ" href="recipes.html" />
|
||||
<link rel="prev" title="Import and Export" href="export.html" />
|
||||
|
||||
|
|
|
|||
6
docs/_build/html/encryption.html
vendored
6
docs/_build/html/encryption.html
vendored
|
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Encryption — jrnl 1.7.10 documentation</title>
|
||||
<title>Encryption — jrnl 1.7.12 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.7.10',
|
||||
VERSION: '1.7.12',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
<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>
|
||||
<link rel="top" title="jrnl 1.7.10 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.12 documentation" href="index.html" />
|
||||
<link rel="next" title="Import and Export" href="export.html" />
|
||||
<link rel="prev" title="Basic Usage" href="usage.html" />
|
||||
|
||||
|
|
|
|||
6
docs/_build/html/export.html
vendored
6
docs/_build/html/export.html
vendored
|
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Import and Export — jrnl 1.7.10 documentation</title>
|
||||
<title>Import and Export — jrnl 1.7.12 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.7.10',
|
||||
VERSION: '1.7.12',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
<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>
|
||||
<link rel="top" title="jrnl 1.7.10 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.12 documentation" href="index.html" />
|
||||
<link rel="next" title="Advanced Usage" href="advanced.html" />
|
||||
<link rel="prev" title="Encryption" href="encryption.html" />
|
||||
|
||||
|
|
|
|||
6
docs/_build/html/genindex.html
vendored
6
docs/_build/html/genindex.html
vendored
|
|
@ -9,7 +9,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Index — jrnl 1.7.10 documentation</title>
|
||||
<title>Index — jrnl 1.7.12 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -17,7 +17,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.7.10',
|
||||
VERSION: '1.7.12',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -26,7 +26,7 @@
|
|||
<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>
|
||||
<link rel="top" title="jrnl 1.7.10 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.12 documentation" href="index.html" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
||||
<link rel="apple-touch-icon-precomposed" href="_static/img/favicon-152.png">
|
||||
|
|
|
|||
6
docs/_build/html/installation.html
vendored
6
docs/_build/html/installation.html
vendored
|
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Getting started — jrnl 1.7.10 documentation</title>
|
||||
<title>Getting started — jrnl 1.7.12 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.7.10',
|
||||
VERSION: '1.7.12',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
<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>
|
||||
<link rel="top" title="jrnl 1.7.10 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.12 documentation" href="index.html" />
|
||||
<link rel="next" title="Basic Usage" href="usage.html" />
|
||||
<link rel="prev" title="Overview" href="overview.html" />
|
||||
|
||||
|
|
|
|||
BIN
docs/_build/html/objects.inv
vendored
BIN
docs/_build/html/objects.inv
vendored
Binary file not shown.
6
docs/_build/html/overview.html
vendored
6
docs/_build/html/overview.html
vendored
|
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Overview — jrnl 1.7.10 documentation</title>
|
||||
<title>Overview — jrnl 1.7.12 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.7.10',
|
||||
VERSION: '1.7.12',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
<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>
|
||||
<link rel="top" title="jrnl 1.7.10 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.12 documentation" href="index.html" />
|
||||
<link rel="next" title="Getting started" href="installation.html" />
|
||||
<link rel="prev" title="jrnl: The command-line journal" href="index.html" />
|
||||
|
||||
|
|
|
|||
6
docs/_build/html/recipes.html
vendored
6
docs/_build/html/recipes.html
vendored
|
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>FAQ — jrnl 1.7.10 documentation</title>
|
||||
<title>FAQ — jrnl 1.7.12 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.7.10',
|
||||
VERSION: '1.7.12',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
<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>
|
||||
<link rel="top" title="jrnl 1.7.10 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.12 documentation" href="index.html" />
|
||||
<link rel="prev" title="Advanced Usage" href="advanced.html" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
||||
|
|
|
|||
6
docs/_build/html/search.html
vendored
6
docs/_build/html/search.html
vendored
|
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Search — jrnl 1.7.10 documentation</title>
|
||||
<title>Search — jrnl 1.7.12 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.7.10',
|
||||
VERSION: '1.7.12',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -25,7 +25,7 @@
|
|||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/searchtools.js"></script>
|
||||
<link rel="top" title="jrnl 1.7.10 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.12 documentation" href="index.html" />
|
||||
<script type="text/javascript">
|
||||
jQuery(function() { Search.loadIndex("searchindex.js"); });
|
||||
</script>
|
||||
|
|
|
|||
2
docs/_build/html/searchindex.js
vendored
2
docs/_build/html/searchindex.js
vendored
File diff suppressed because one or more lines are too long
15
docs/_build/html/usage.html
vendored
15
docs/_build/html/usage.html
vendored
|
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Basic Usage — jrnl 1.7.10 documentation</title>
|
||||
<title>Basic Usage — jrnl 1.7.12 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.7.10',
|
||||
VERSION: '1.7.12',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
<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>
|
||||
<link rel="top" title="jrnl 1.7.10 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.12 documentation" href="index.html" />
|
||||
<link rel="next" title="Encryption" href="encryption.html" />
|
||||
<link rel="prev" title="Getting started" href="installation.html" />
|
||||
|
||||
|
|
@ -44,6 +44,14 @@
|
|||
<span id="usage"></span><h1>Basic Usage<a class="headerlink" href="#basic-usage" title="Permalink to this headline">¶</a></h1>
|
||||
<p><em>jrnl</em> has two modes: <strong>composing</strong> and <strong>viewing</strong>. Basically, whenever you <cite>don’t</cite> supply any arguments that start with a dash or double-dash, you’re in composing mode, meaning you can write your entry on the command line or an editor of your choice.</p>
|
||||
<p>We intentionally break a convention on command line arguments: all arguments starting with a <cite>single dash</cite> will <cite>filter</cite> your journal before viewing it, and can be combined arbitrarily. Arguments with a <cite>double dash</cite> will control how your journal is displayed or exported and are mutually exclusive (ie. you can only specify one way to display or export your journal at a time).</p>
|
||||
<div class="section" id="listing-journals">
|
||||
<h2>Listing Journals<a class="headerlink" href="#listing-journals" title="Permalink to this headline">¶</a></h2>
|
||||
<p>You can list the journals accessible by jrnl:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="n">jrnl</span> <span class="o">-</span><span class="n">ls</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The journals displayed correspond to those specified in the jrnl configuration file.</p>
|
||||
</div>
|
||||
<div class="section" id="composing-entries">
|
||||
<h2>Composing Entries<a class="headerlink" href="#composing-entries" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Composing mode is entered by either starting <tt class="docutils literal"><span class="pre">jrnl</span></tt> without any arguments – which will prompt you to write an entry or launch your editor – or by just writing an entry on the prompt, such as:</p>
|
||||
|
|
@ -150,6 +158,7 @@ I just figured I'd be on the other side.</pre>
|
|||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Getting started</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="">Basic Usage</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#listing-journals">Listing Journals</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#composing-entries">Composing Entries</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#smart-timestamps">Smart timestamps</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#starring-entries">Starring entries</a></li>
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Encryption — jrnl 1.7.10 documentation</title>
|
||||
<title>Encryption — jrnl 1.7.12 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.7.10',
|
||||
VERSION: '1.7.12',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
<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>
|
||||
<link rel="top" title="jrnl 1.7.10 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.12 documentation" href="index.html" />
|
||||
<link rel="next" title="Import and Export" href="export.html" />
|
||||
<link rel="prev" title="Basic Usage" href="usage.html" />
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Import and Export — jrnl 1.7.10 documentation</title>
|
||||
<title>Import and Export — jrnl 1.7.12 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.7.10',
|
||||
VERSION: '1.7.12',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
<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>
|
||||
<link rel="top" title="jrnl 1.7.10 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.12 documentation" href="index.html" />
|
||||
<link rel="next" title="Advanced Usage" href="advanced.html" />
|
||||
<link rel="prev" title="Encryption" href="encryption.html" />
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Index — jrnl 1.7.10 documentation</title>
|
||||
<title>Index — jrnl 1.7.12 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -17,7 +17,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.7.10',
|
||||
VERSION: '1.7.12',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -26,7 +26,7 @@
|
|||
<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>
|
||||
<link rel="top" title="jrnl 1.7.10 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.12 documentation" href="index.html" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
||||
<link rel="apple-touch-icon-precomposed" href="_static/img/favicon-152.png">
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Getting started — jrnl 1.7.10 documentation</title>
|
||||
<title>Getting started — jrnl 1.7.12 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.7.10',
|
||||
VERSION: '1.7.12',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
<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>
|
||||
<link rel="top" title="jrnl 1.7.10 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.12 documentation" href="index.html" />
|
||||
<link rel="next" title="Basic Usage" href="usage.html" />
|
||||
<link rel="prev" title="Overview" href="overview.html" />
|
||||
|
||||
|
|
|
|||
BIN
jrnl/Entry.pyc
BIN
jrnl/Entry.pyc
Binary file not shown.
BIN
jrnl/Journal.pyc
BIN
jrnl/Journal.pyc
Binary file not shown.
Binary file not shown.
BIN
jrnl/cli.pyc
BIN
jrnl/cli.pyc
Binary file not shown.
Binary file not shown.
BIN
jrnl/install.pyc
BIN
jrnl/install.pyc
Binary file not shown.
BIN
jrnl/util.pyc
BIN
jrnl/util.pyc
Binary file not shown.
BIN
objects.inv
BIN
objects.inv
Binary file not shown.
|
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Overview — jrnl 1.7.10 documentation</title>
|
||||
<title>Overview — jrnl 1.7.12 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.7.10',
|
||||
VERSION: '1.7.12',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
<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>
|
||||
<link rel="top" title="jrnl 1.7.10 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.12 documentation" href="index.html" />
|
||||
<link rel="next" title="Getting started" href="installation.html" />
|
||||
<link rel="prev" title="jrnl: The command-line journal" href="index.html" />
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>FAQ — jrnl 1.7.10 documentation</title>
|
||||
<title>FAQ — jrnl 1.7.12 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.7.10',
|
||||
VERSION: '1.7.12',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
<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>
|
||||
<link rel="top" title="jrnl 1.7.10 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.12 documentation" href="index.html" />
|
||||
<link rel="prev" title="Advanced Usage" href="advanced.html" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Search — jrnl 1.7.10 documentation</title>
|
||||
<title>Search — jrnl 1.7.12 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.7.10',
|
||||
VERSION: '1.7.12',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -25,7 +25,7 @@
|
|||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/searchtools.js"></script>
|
||||
<link rel="top" title="jrnl 1.7.10 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.12 documentation" href="index.html" />
|
||||
<script type="text/javascript">
|
||||
jQuery(function() { Search.loadIndex("searchindex.js"); });
|
||||
</script>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
15
usage.html
15
usage.html
|
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Basic Usage — jrnl 1.7.10 documentation</title>
|
||||
<title>Basic Usage — jrnl 1.7.12 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.7.10',
|
||||
VERSION: '1.7.12',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
<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>
|
||||
<link rel="top" title="jrnl 1.7.10 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.12 documentation" href="index.html" />
|
||||
<link rel="next" title="Encryption" href="encryption.html" />
|
||||
<link rel="prev" title="Getting started" href="installation.html" />
|
||||
|
||||
|
|
@ -44,6 +44,14 @@
|
|||
<span id="usage"></span><h1>Basic Usage<a class="headerlink" href="#basic-usage" title="Permalink to this headline">¶</a></h1>
|
||||
<p><em>jrnl</em> has two modes: <strong>composing</strong> and <strong>viewing</strong>. Basically, whenever you <cite>don’t</cite> supply any arguments that start with a dash or double-dash, you’re in composing mode, meaning you can write your entry on the command line or an editor of your choice.</p>
|
||||
<p>We intentionally break a convention on command line arguments: all arguments starting with a <cite>single dash</cite> will <cite>filter</cite> your journal before viewing it, and can be combined arbitrarily. Arguments with a <cite>double dash</cite> will control how your journal is displayed or exported and are mutually exclusive (ie. you can only specify one way to display or export your journal at a time).</p>
|
||||
<div class="section" id="listing-journals">
|
||||
<h2>Listing Journals<a class="headerlink" href="#listing-journals" title="Permalink to this headline">¶</a></h2>
|
||||
<p>You can list the journals accessible by jrnl:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="n">jrnl</span> <span class="o">-</span><span class="n">ls</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The journals displayed correspond to those specified in the jrnl configuration file.</p>
|
||||
</div>
|
||||
<div class="section" id="composing-entries">
|
||||
<h2>Composing Entries<a class="headerlink" href="#composing-entries" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Composing mode is entered by either starting <tt class="docutils literal"><span class="pre">jrnl</span></tt> without any arguments – which will prompt you to write an entry or launch your editor – or by just writing an entry on the prompt, such as:</p>
|
||||
|
|
@ -150,6 +158,7 @@ I just figured I'd be on the other side.</pre>
|
|||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Getting started</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="">Basic Usage</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#listing-journals">Listing Journals</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#composing-entries">Composing Entries</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#smart-timestamps">Smart timestamps</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#starring-entries">Starring entries</a></li>
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue