.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "BLAZE-EDIT 1" .TH BLAZE-EDIT 1 "2019-10-07" "Version 1.2.0" "BlazeBlogger Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" blaze\-edit \- edits a blog post or a page in the BlazeBlogger repository .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBblaze-edit\fR [\fB\-fpqCPV\fR] [\fB\-b\fR \fIdirectory\fR] [\fB\-E\fR \fIeditor\fR] \fIid\fR .PP \&\fBblaze-edit\fR \fB\-h\fR|\fB\-v\fR .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBblaze-edit\fR opens an existing blog post or a page with the specified \&\fIid\fR in an external text editor. Note that there are several special forms and placeholders that can be used in the text, and that will be replaced with a proper data when the blog is generated. .SS "Special Forms" .IX Subsection "Special Forms" .IP "\fB\fR" 4 .IX Item "" A mark to delimit a blog post synopsis. .SS "Placeholders" .IX Subsection "Placeholders" .IP "\fB\f(CB%root\fB%\fR" 4 .IX Item "%root%" A relative path to the root directory of the blog. .IP "\fB\f(CB%home\fB%\fR" 4 .IX Item "%home%" A relative path to the index page of the blog. .IP "\fB\f(CB%page\fB[\fR\fIid\fR\fB]%\fR" 4 .IX Item "%page[id]%" A relative path to a page with the supplied \fIid\fR. .IP "\fB\f(CB%post\fB[\fR\fIid\fR\fI]%\fR" 4 .IX Item "%post[id]%" A relative path to a blog post with the supplied \fIid\fR. .IP "\fB\f(CB%tag\fB[\fR\fIname\fR\fB]%\fR" 4 .IX Item "%tag[name]%" A relative path to a tag with the supplied \fIname\fR. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-b\fR \fIdirectory\fR, \fB\-\-blogdir\fR \fIdirectory\fR" 4 .IX Item "-b directory, --blogdir directory" Allows you to specify a \fIdirectory\fR in which the BlazeBlogger repository is placed. The default option is a current working directory. .IP "\fB\-E\fR \fIeditor\fR, \fB\-\-editor\fR \fIeditor\fR" 4 .IX Item "-E editor, --editor editor" Allows you to specify an external text \fIeditor\fR. When supplied, this option overrides the relevant configuration option. .IP "\fB\-p\fR, \fB\-\-page\fR" 4 .IX Item "-p, --page" Tells \fBblaze-edit\fR to edit a page or pages. .IP "\fB\-P\fR, \fB\-\-post\fR" 4 .IX Item "-P, --post" Tells \fBblaze-edit\fR to edit a blog post or blog posts. This is the default option. .IP "\fB\-f\fR, \fB\-\-force\fR" 4 .IX Item "-f, --force" Tells \fBblaze-edit\fR to create an empty source file in case it does not already exist. If the \fBcore.processor\fR option is enabled, this file is used as the input to be processed by the selected application. .IP "\fB\-C\fR, \fB\-\-no\-processor\fR" 4 .IX Item "-C, --no-processor" Disables processing a blog post or page with an external application. .IP "\fB\-q\fR, \fB\-\-quiet\fR" 4 .IX Item "-q, --quiet" Disables displaying of unnecessary messages. .IP "\fB\-V\fR, \fB\-\-verbose\fR" 4 .IX Item "-V, --verbose" Enables displaying of all messages. This is the default option. .IP "\fB\-h\fR, \fB\-\-help\fR" 4 .IX Item "-h, --help" Displays usage information and exits. .IP "\fB\-v\fR, \fB\-\-version\fR" 4 .IX Item "-v, --version" Displays version information and exits. .SH "ENVIRONMENT" .IX Header "ENVIRONMENT" .IP "\fB\s-1EDITOR\s0\fR" 4 .IX Item "EDITOR" Unless the \fBcore.editor\fR option is set, BlazeBlogger tries to use system-wide settings to decide which editor to use. .SH "EXAMPLE USAGE" .IX Header "EXAMPLE USAGE" Edit a blog post in an external text editor: .PP .Vb 1 \& ~]$ blaze\-edit 10 .Ve .PP Edit a page in an external text editor: .PP .Vb 1 \& ~]$ blaze\-edit \-p 4 .Ve .PP Edit a page in \fBnano\fR: .PP .Vb 1 \& ~]$ blaze\-edit \-p 2 \-E nano .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBblaze-config\fR(1), \fBblaze-add\fR(1), \fBblaze-list\fR(1) .SH "BUGS" .IX Header "BUGS" To report a bug or to send a patch, please, add a new issue to the bug tracker at , or visit the discussion group at . .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2008\-2011 Jaromir Hradilek .PP This program is free software; see the source for copying conditions. It is distributed in the hope that it will be useful, but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0