Virata manual

manual

Opens this manual in your browser, at the page for whatever you name.

What we have

  • a page for every command, chart and reference topic
  • abbreviations, so manual su finds summarize
  • it is a local file: no internet connection is needed
  • VIRATA_NO_BROWSER=1 makes it print the path instead of opening it

Coming later

  • searching the manual from the prompt — the index page has a search box
  • opening it inside the desktop window; it opens in your browser instead, because the app deliberately ships without an embedded browser engine

You may shorten it to man.

How you write it

manual [command | chart | topic]

Square brackets mean optional. A vertical bar means choose one.

What it does

help summarize prints eight lines at the prompt, which is what you want when you have half-forgotten an option. manual summarize opens the page you are reading now: the plain-English explanation, what works and what does not yet, the examples with the output they really produced, and the same command in pandas and in R.

. manual                  the contents
. manual summarize        one command
. manual graph bar        one chart
. manual charts           the chart gallery
. manual expressions      a reference page

Command names can be abbreviated the same way they can anywhere else, so manual su works.

The whole manual travels inside the program, so this is a local file and not a website. It works on a train.

Nearby

set log help recipe display local