summaryrefslogtreecommitdiffstats
path: root/docs/tutorials/playground
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 17:44:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 17:44:55 +0000
commit5068d34c08f951a7ea6257d305a1627b09a95817 (patch)
tree08213e2be853396a3b07ce15dbe222644dcd9a89 /docs/tutorials/playground
parentInitial commit. (diff)
downloadlnav-upstream.tar.xz
lnav-upstream.zip
Adding upstream version 0.11.1.upstream/0.11.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/tutorials/playground')
-rw-r--r--docs/tutorials/playground/index.md9
-rw-r--r--docs/tutorials/playground/logs/access_log.gzbin0 -> 36529 bytes
-rw-r--r--docs/tutorials/playground/logs/messages.gzbin0 -> 14034 bytes
-rwxr-xr-xdocs/tutorials/playground/run.sh16
-rw-r--r--docs/tutorials/playground/text/markdown-sample.md157
5 files changed, 182 insertions, 0 deletions
diff --git a/docs/tutorials/playground/index.md b/docs/tutorials/playground/index.md
new file mode 100644
index 0000000..e1516b1
--- /dev/null
+++ b/docs/tutorials/playground/index.md
@@ -0,0 +1,9 @@
+
+# Playground
+
+Welcome to the **lnav** playground!
+
+There are some sample files loaded into the log and text views.
+Press `q` to switch back to the log view and start exploring.
+You can also press `f` in this view to switch to the other
+text files that are loaded, like a markdown sample.
diff --git a/docs/tutorials/playground/logs/access_log.gz b/docs/tutorials/playground/logs/access_log.gz
new file mode 100644
index 0000000..485cf4e
--- /dev/null
+++ b/docs/tutorials/playground/logs/access_log.gz
Binary files differ
diff --git a/docs/tutorials/playground/logs/messages.gz b/docs/tutorials/playground/logs/messages.gz
new file mode 100644
index 0000000..e6ad012
--- /dev/null
+++ b/docs/tutorials/playground/logs/messages.gz
Binary files differ
diff --git a/docs/tutorials/playground/run.sh b/docs/tutorials/playground/run.sh
new file mode 100755
index 0000000..4a6723d
--- /dev/null
+++ b/docs/tutorials/playground/run.sh
@@ -0,0 +1,16 @@
+#!/bin/bash
+
+export LNAVSECURE=1
+export TERM=xterm-256color
+
+timeout --foreground --kill-after=30s 10m lnav \
+ -d "/tmp/$(echo "playground."$(date "+%Y-%m-%dT%H-%M-%S")".$$.log")" \
+ /tutorials/playground/logs \
+ /tutorials/playground/text \
+ /tutorials/playground/index.md#playground
+
+if [ $? = 124 ]; then
+ echo "error: reached connection time limit, reconnect if you're not a bot."
+else
+ echo "Thanks for trying out lnav! Have a nice day!"
+fi
diff --git a/docs/tutorials/playground/text/markdown-sample.md b/docs/tutorials/playground/text/markdown-sample.md
new file mode 100644
index 0000000..4b56cae
--- /dev/null
+++ b/docs/tutorials/playground/text/markdown-sample.md
@@ -0,0 +1,157 @@
+An h1 header
+============
+
+Paragraphs are separated by a blank line.
+
+2nd paragraph. *Italic*, **bold**, and `monospace`. Itemized lists
+look like:
+
+ * this one
+ * that one
+ * the other one
+
+Note that --- not considering the asterisk --- the actual text
+content starts at 4-columns in.
+
+> Block quotes are
+> written like so.
+>
+> They can span multiple paragraphs,
+> if you like.
+
+Use 3 dashes for an em-dash. Use 2 dashes for ranges (ex., "it's all
+in chapters 12--14"). Three dots ... will be converted to an ellipsis.
+Unicode is supported. ☺
+
+
+
+An h2 header
+------------
+
+Here's a numbered list:
+
+ 1. first item
+ 2. second item
+ 3. third item
+
+Note again how the actual text starts at 4 columns in (4 characters
+from the left side). Here's a code sample:
+
+ # Let me re-iterate ...
+ for i in 1 .. 10 { do-something(i) }
+
+As you probably guessed, indented 4 spaces. By the way, instead of
+indenting the block, you can use delimited blocks, if you like:
+
+~~~
+define foobar() {
+ print "Welcome to flavor country!";
+}
+~~~
+
+(which makes copying & pasting easier). You can optionally mark the
+delimited block for Pandoc to syntax highlight it:
+
+~~~python
+import time
+# Quick, count to ten!
+for i in range(10):
+ # (but not *too* quick)
+ time.sleep(0.5)
+ print i
+~~~
+
+
+
+### An h3 header ###
+
+Now a nested list:
+
+ 1. First, get these ingredients:
+
+ * carrots
+ * celery
+ * lentils
+
+ 2. Boil some water.
+
+ 3. Dump everything in the pot and follow
+ this algorithm:
+
+ find wooden spoon
+ uncover pot
+ stir
+ cover pot
+ balance wooden spoon precariously on pot handle
+ wait 10 minutes
+ goto first step (or shut off burner when done)
+
+ Do not bump wooden spoon or it will fall.
+
+Notice again how text always lines up on 4-space indents (including
+that last line which continues item 3 above).
+
+Here's a link to [a website](https://lnav.org), to a [local
+doc](../index.md), and to a [section heading in the current
+doc](#an-h2-header). Here's a footnote [^1].
+
+[^1]: Footnote text goes here.
+
+Tables can look like this:
+
+size material color
+---- ------------ ------------
+9 leather brown
+10 hemp canvas natural
+11 glass transparent
+
+Table: Shoes, their sizes, and what they're made of
+
+(The above is the caption for the table.) Pandoc also supports
+multi-line tables:
+
+-------- -----------------------
+keyword text
+-------- -----------------------
+red Sunsets, apples, and
+ other red or reddish
+ things.
+
+green Leaves, grass, frogs
+ and other things it's
+ not easy being.
+-------- -----------------------
+
+A horizontal rule follows.
+
+***
+
+Here's a definition list:
+
+apples
+ : Good for making applesauce.
+oranges
+ : Citrus!
+tomatoes
+ : There's no "e" in tomatoe.
+
+Again, text is indented 4 spaces. (Put a blank line between each
+term/definition pair to spread things out more.)
+
+Here's a "line block":
+
+| Line one
+| Line too
+| Line tree
+
+and images can be specified like so:
+
+![example image](../../../assets/images/lnav-front-page.png "An exemplary image")
+
+Inline math equations go in like so: $\omega = d\phi / dt$. Display
+math should get its own line and be put in in double-dollarsigns:
+
+$$I = \int \rho R^{2} dV$$
+
+And note that you can backslash-escape any punctuation characters
+which you wish to be displayed literally, ex.: \`foo\`, \*bar\*, etc. \ No newline at end of file