aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2018-01-15 12:31:26 +1300
committerTom Ryder <tom@sanctum.geek.nz>2018-01-15 12:31:26 +1300
commit99c655cd11cd9000a496bde9c9fced98308c6454 (patch)
treedfec0895cc9448af3c8eb6ffb7eac0b662315456 /man
parentMerge branch 'hotfix/v0.22.1' (diff)
parentBump version number to 0.23.0 (diff)
downloaddotfiles-99c655cd11cd9000a496bde9c9fced98308c6454.tar.gz
dotfiles-99c655cd11cd9000a496bde9c9fced98308c6454.zip
Merge branch 'release/v0.23.0'v0.23.0
* release/v0.23.0: Bump version number to 0.23.0 Remove unused `self` var from clog(1df) Change double-quote printf pattern to single-quote Move ShellCheck line to correct place in sra(1df) Quote EDITOR/VISUAL assignments for clarity Explicitly ignore uninteresting tree(1) opts Refactor clog(1df), allow args and non-term stdin Reimplement bl(1df) in Awk Separate ax(1df) manpage args from command Make newline explicit for ax(1df) Make first ax(1df) arg safer, warn on second arg Correct monospaced blocks in Vim plugin docs
Diffstat (limited to 'man')
-rw-r--r--man/man1/ax.1df12
-rw-r--r--man/man1/clog.1df20
2 files changed, 24 insertions, 8 deletions
diff --git a/man/man1/ax.1df b/man/man1/ax.1df
index b3218d37..40125167 100644
--- a/man/man1/ax.1df
+++ b/man/man1/ax.1df
@@ -1,15 +1,21 @@
-.TH AX 1df "July 2016" "Manual page for ax"
+.TH AX 1df "January 2018" "Manual page for ax"
.SH NAME
.B ax
\- evaluate an awk expression
.SH SYNOPSIS
-.B ax '2.0+3.0'
+.B ax
+\&'2.0+3.0'
.br
-.B ax %.2f 'sin(2)'
+.B ax
+\&'%.2f\\n' 'sin(2)'
.SH DESCRIPTION
.B ax
evaluates an expression given on the command line with awk(1) and prints its
result using awk's printf, with an optional format specified preceding the
expression.
+.SH SECURITY
+Note that the second argument has no evaluation protection on it. There's very
+little to stop a user putting a fully-fledged awk program in as the second
+argument if they needed to. Don't accept untrusted user input in this argument!
.SH AUTHOR
Tom Ryder <tom@sanctum.geek.nz>
diff --git a/man/man1/clog.1df b/man/man1/clog.1df
index 43193076..f9300347 100644
--- a/man/man1/clog.1df
+++ b/man/man1/clog.1df
@@ -3,18 +3,28 @@
.B clog
\- record timestamped logs in a file
.SH SYNOPSIS
+$
.B clog
.br
-getting real tired of all this overengineering
+Getting real tired of all this overengineering.
.br
^D
+.br
+$
+.B clog
+file1 file2
+.br
+$
+command |
+.B clog
.SH DESCRIPTION
.B clog
-receives a message on stdin, timestamps it with a leading date(1), and writes
-it to the file with path in environment variable CLOG, defaulting to ~/.clog,
-terminating each entry with two hyphens.
+receives a message on stdin or from the file arguments, timestamps it with a
+leading date(1), and writes it to the file with path in environment variable
+CLOG, defaulting to ~/.clog, terminating each entry with two hyphens.
.P
-If rlwrap(1) is found, it will be used for the line editing. If not, just the
+If there are no files to read and standard input is coming from a terminal, and
+rlwrap(1) is found, it will be used for the line editing. If not, just the
terminal's cooked mode will be used.
.SH AUTHOR
Tom Ryder <tom@sanctum.geek.nz>