cloudhead.io · commit

Add usage section to rx

c384b41e340fa7c3f871f7b55ace59a1a39f2e43

Alexis Sellier committed 6 years ago 1 parent 02fc6f19

rx/index.html +24 -0

      code {
        color: #aaa;
        font-style: italic;
      }

      pre {
        font-size: 0.8em;
      }

      section > header {
        margin-bottom: 10px;
      }

      section > header > h2 {


      <p>The default installed palette is <a href="palettes/sweetie16.palette">sweetie16.palette</a>.
      Other palettes are also available <a href="palettes/">here</a>, and you can create your own.</p>
    </section>

    <section>
      <h2>USAGE</h2>

      <p>After installing, simply run <em>rx</em> from a shell or application launcher.
      You can then use the <code>:help</code> command to show the current set of key mappings
      and commands.</p>

      <p>Common commands:</p>

      <pre>
      :help                    Display help
      :e &lt;path..&gt;              Edit path(s)
      :w                       Write/save view
      :q                       Quit view
      :slice &lt;n&gt;               Slice view into &lt;n&gt; frames
      :source &lt;path&gt;           Source an rx script (eg. a palette)
      :f/resize &lt;w&gt; &lt;h&gt;        Resize frames
      </pre>
    </section>

    <section>
      <h2>CONFIGURATION</h2>
      <p>Configuring <em>rx</em> involves editing the <em>init.rx</em>
      script, which is found in a platform-dependent location. On Linux, this
      is in the XDG config directory, eg. <em>~/.config/rx/init.rx</em>, while on

54	54		code {
55	55		color: #aaa;
56	56		font-style: italic;
57	57		}
58	58
	59	+	pre {
	60	+	font-size: 0.8em;
	61	+	}
	62	+
59	63		section > header {
60	64		margin-bottom: 10px;
61	65		}
62	66
63	67		section > header > h2 {

248	252
249	253		<p>The default installed palette is <a href="palettes/sweetie16.palette">sweetie16.palette</a>.
250	254		Other palettes are also available <a href="palettes/">here</a>, and you can create your own.</p>
251	255		</section>
252	256
	257	+	<section>
	258	+	<h2>USAGE</h2>
	259	+
	260	+	<p>After installing, simply run <em>rx</em> from a shell or application launcher.
	261	+	You can then use the <code>:help</code> command to show the current set of key mappings
	262	+	and commands.</p>
	263	+
	264	+	<p>Common commands:</p>
	265	+
	266	+	<pre>
	267	+	:help Display help
	268	+	:e <path..> Edit path(s)
	269	+	:w Write/save view
	270	+	:q Quit view
	271	+	:slice <n> Slice view into <n> frames
	272	+	:source <path> Source an rx script (eg. a palette)
	273	+	:f/resize <w> <h> Resize frames
	274	+	</pre>
	275	+	</section>
	276	+
253	277		<section>
254	278		<h2>CONFIGURATION</h2>
255	279		<p>Configuring <em>rx</em> involves editing the <em>init.rx</em>
256	280		script, which is found in a platform-dependent location. On Linux, this
257	281		is in the XDG config directory, eg. <em>~/.config/rx/init.rx</em>, while on