diff options
Diffstat (limited to 'man/blogc.1.ronn')
| -rw-r--r-- | man/blogc.1.ronn | 57 |
1 files changed, 13 insertions, 44 deletions
diff --git a/man/blogc.1.ronn b/man/blogc.1.ronn index 11f7808..a97122b 100644 --- a/man/blogc.1.ronn +++ b/man/blogc.1.ronn @@ -3,21 +3,14 @@ blogc(1) -- a blog compiler ## SYNOPSIS -`blogc` [`-d`] [`-D` <KEY>=<VALUE> ...] `-t` <TEMPLATE> [`-o` <OUTPUT>] <SOURCE><br> -`blogc` `-l` [`-e` <SOURCE>] [`-d`] [`-D` <KEY>=<VALUE> ...] `-t` <TEMPLATE> [`-o` <OUTPUT>] [<SOURCE> ...]<br> -`blogc` `-l` [`-e` <SOURCE>] [`-d`] [`-D` <KEY>=<VALUE> ...] `-t` <TEMPLATE> [`-o` <OUTPUT>] [<SOURCE> ...]<br> -`blogc` `-l` [`-e` <SOURCE>] `-p` <KEY> [`-d`] [`-D` <KEY>=<VALUE> ...] [<SOURCE> ...]<br> -`blogc` `-i` [`-d`] [`-D` <KEY>=<VALUE> ...] `-t` <TEMPLATE> [`-o` <OUTPUT>] < <FILE_LIST><br> -`blogc` `-i` `-l` [`-e` <SOURCE>] [`-d`] [`-D` <KEY>=<VALUE> ...] `-t` <TEMPLATE> [`-o` <OUTPUT>] < <FILE_LIST><br> -`blogc` `-i` `-l` [`-e` <SOURCE>] `-p` <KEY> [`-d`] [`-D` <KEY>=<VALUE> ...] < <FILE_LIST><br> -`echo` `-e` "<SOURCE>\n..." | `blogc` `-i` [`-d`] [`-D` <KEY>=<VALUE> ...] `-t` <TEMPLATE> [`-o` <OUTPUT>]<br> -`echo` `-e` "<SOURCE>\n..." | `blogc` `-i` `-l` [`-e` <SOURCE>] [`-d`] [`-D` <KEY>=<VALUE> ...] `-t` <TEMPLATE> [`-o` <OUTPUT>]<br> -`echo` `-e` "<SOURCE>\n..." | `blogc` `-i` `-l` [`-e` <SOURCE>] `-p` <KEY> [`-d`] [`-D` <KEY>=<VALUE> ...]<br> +`blogc` `-d` [`-D` <KEY>=<VALUE> ...] `-t` <TEMPLATE> [`-o` <OUTPUT>] <SOURCE><br> +`blogc` `-d` `-l` [`-D` <KEY>=<VALUE> ...] `-t` <TEMPLATE> [`-o` <OUTPUT>] [<SOURCE> ...]<br> +`blogc` `-d` `-l` `-p` <KEY> [`-D` <KEY>=<VALUE> ...] [<SOURCE> ...]<br> `blogc` [`-h`|`-v`] ## DESCRIPTION -**blogc** compiles source files and templates into blog/website resources. It +**blogc** converts source files and templates into blog/website resources. It gets one (or more) source files and a template, and generates an output file, based on the template and the content read from the source file(s). It was designed to be used with make(1). @@ -30,39 +23,20 @@ designed to be used with make(1). page or a post. * `listing`: - Listing mode, second example in [SYNOPSIS][], activated when calling `blogc` - with `-l` option. Accepts multiple source files, and allow users to iterate - over the content of all the source files to produce listing pages, like - indexes and feeds. By providing another source file to `blogc` with `-e` - option, third example in [SYNOPSIS][], its content will be available for usage - during listing, similar to the default entry mode. This is useful for users - that want to have an index page with content and posts listing together. - See blogc-template(7) for details. + Listing mode, second example in [SYNOPSIS][], activated when + calling `blogc` with `-l` option. Accepts multiple source files, and allow + users to iterate over the content of all the source files to produce listing + pages, like indexes and feeds. ## OPTIONS * `-d`: Activates debug. - * `-i`: - Reads list of source files from standard input. Content of standard input is - parsed as a file where each line is a file path. Empty lines and lines - starting with `#` are ignored. If some source files are provided to command - line while using this option, they will be parsed **before** the files read - from standard input. - * `-l`: Activates listing mode, allowing user to provide multiple source files. See blogc-source(7) for details. - * `-e` <SOURCE>: - When used together with `-l` the source file will be parsed and its content - will be made available for usage in the templates in listing mode via - `listing_entry` blocks. This option can be used more than once, so users can - have more than one `listing_entry` block in the same template. Passing an - empty string will skip the `listing_entry` block. See blogc-template(7) for - details. - * `-D` <KEY>=<VALUE>: Set global configuration parameter. <KEY> must be an ascii uppercase string, with only letters, numbers (after the first letter) and underscores (after @@ -71,10 +45,9 @@ designed to be used with make(1). See blogc-template(7) for details. * `-p` <KEY>: - Show the value of a variable right after the source parsing and exits. This - is useful to get parameters for your `Makefile`, like the last page when - implementing pagination, see blogc-pagination(7) for details. This option can - also dump variables defined in a source file, if called without `-l`. + Show the value of a global configuration parameter right after the source + parsing and exits. This is useful to get parameters for your `Makefile`, + like the last page when using pagination, see blogc-pagination(7) for details. * `-t` <TEMPLATE>: Template file. It is a required option, if `blogc` needs to render something. @@ -100,7 +73,7 @@ files must have valid UTF-8 content. No environment variables are required by `blogc`, but global timezone will be used by locale-dependant datetime input field descriptors (like `%c`), and -can be overridden using environment variables. See strftime(3). +can be overridden using environment variables. See strptime(3). ## EXAMPLES @@ -108,10 +81,6 @@ Build index from source files: $ blogc -l -t template.tmpl -o index.html source1.txt source2.txt source3.txt -Build index from source files, with additional content from `index.txt`: - - $ blogc -l -e index.txt -t template.tmpl -o index.html source1.txt source2.txt source3.txt - Build entry page from source file: $ blogc -t template.tmpl -o entry.html entry.txt @@ -128,4 +97,4 @@ Rafael G. Martins <<rafael@rafaelmartins.eng.br>> ## SEE ALSO -blogc-source(7), blogc-template(7), blogc-pagination(7) make(1), strftime(3) +blogc-source(7), blogc-template(7), blogc-pagination(7) make(1), strptime(3) |