From 703e9e93087d32364087a0ebc9e315869b70ff7c Mon Sep 17 00:00:00 2001 From: Case Duckworth Date: Sat, 15 Jun 2024 21:17:03 -0500 Subject: Update things --- README.gmi | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) (limited to 'README.gmi') diff --git a/README.gmi b/README.gmi index a3e10fd..88dde93 100644 --- a/README.gmi +++ b/README.gmi @@ -38,12 +38,12 @@ offers a normalization function. tags do not stretch over source line breaks, and there is no check as to whether they're properly nested. -### Incompatible changes +### Incompatible changes (UNIMPLEMENTED) This section should be as short as possible, of course. They're incompatible in that a complying gemtext reader will interpret their meanings as different from -what jimmy text outputs. These changes are behind a flag (TODO!) and can be -disabled at run-time. +what jimmy text outputs. These changes are behind a flag and can be disabled at +run-time. * Lines beginning with two or more spaces are automatically joined with the previous line on output. @@ -52,6 +52,7 @@ disabled at run-time. Jimmy requires CHICKEN 5.3+ as well as the following eggs: +* args * module-declarations * utf8 @@ -59,7 +60,30 @@ To install, simply run `make install`. You can uninstall with `make uninstall`. ## Using jimmy -TODO +You can run jimmy on the command line as a filter or on a file. Run it like +this: + +``` +jimmy [OPTIONS...] [FILE] +``` + +FILE, if present, is the file to read; otherwise read standard input. + +The available options comprise + +* *-t, --to=FORMAT* --- Translate the input to FORMAT, one of `gemini`, `html`, + or a filename with format specifications in it (see OUTPUT FORMATS, below). +* *-n, --no-extensions* --- Don't enable any of the breaking extensions to + gemtext outlined above (NOT IMPLEMENTED) +* *-T, --template=TEMPLATE* --- Wrap the generated text in TEMPLATE using + metadata from the document (see TEMPLATES, below). +* -h, --help --- Show the help text and exit + +### Output Formats + + + +### Templates ## License -- cgit 1.4.1-21-gabe81