.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "PELICAN-THEMES" "1" "Apr 11, 2024" "4" "PELICAN"
.SH NAME
pelican-themes \- A theme manager for Pelican
.SH DESCRIPTION
.sp
\fBpelican\-themes\fP is a command line tool for managing themes for Pelican. See
\fI\%Themes\fP for settings related to themes.
.SS Usage
.nf
pelican\-themes [\-h] [\-l] [\-i theme path [theme path ...]]
.in +2
[\-r theme name [theme name ...]]
[\-s theme path [theme path ...]] [\-v] [\-\-version]
.in -2
.fi
.sp
.SS Optional arguments:
.INDENT 0.0
.TP
.B  \-h\fP,\fB  \-\-help
Show the help and exit
.TP
.B  \-l\fP,\fB  \-\-list
Show the themes already installed
.TP
.BI \-i \ theme_path\fR,\fB \ \-\-install \ theme_path
One or more themes to install
.TP
.BI \-r \ theme_name\fR,\fB \ \-\-remove \ theme_name
One or more themes to remove
.TP
.BI \-s \ theme_path\fR,\fB \ \-\-symlink \ theme_path
Same as \fB\-\-install\fP, but create a symbolic link instead of copying the theme.
Useful for theme development
.TP
.B  \-v\fP,\fB  \-\-verbose
Verbose output
.TP
.B  \-\-version
Print the version of this script
.UNINDENT
.SH EXAMPLES
.SS Listing the installed themes
.sp
With \fBpelican\-themes\fP, you can see the available themes by using the \fB\-l\fP
or \fB\-\-list\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ pelican\-themes \-l
notmyidea
two\-column@
simple
$ pelican\-themes \-\-list
notmyidea
two\-column@
simple
.EE
.UNINDENT
.UNINDENT
.sp
In this example, we can see there are three themes available: \fBnotmyidea\fP,
\fBsimple\fP, and \fBtwo\-column\fP\&.
.sp
\fBtwo\-column\fP is followed by an \fB@\fP because this theme is not copied to
the Pelican theme path, but is instead just linked to it (see \fI\%Creating
symbolic links\fP for details about creating symbolic links).
.sp
Note that you can combine the \fB\-\-list\fP option with the \fB\-v\fP or
\fB\-\-verbose\fP option to get more verbose output, like this:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ pelican\-themes \-v \-l
/usr/local/lib/python2.6/dist\-packages/pelican\-2.6.0\-py2.6.egg/pelican/themes/notmyidea
/usr/local/lib/python2.6/dist\-packages/pelican\-2.6.0\-py2.6.egg/pelican/themes/two\-column (symbolic link to \(ga/home/skami/Dev/Python/pelican\-themes/two\-column\(aq)
/usr/local/lib/python2.6/dist\-packages/pelican\-2.6.0\-py2.6.egg/pelican/themes/simple
.EE
.UNINDENT
.UNINDENT
.SS Installing themes
.sp
You can install one or more themes using the \fB\-i\fP or \fB\-\-install\fP option.
This option takes as argument the path(s) of the theme(s) you want to install,
and can be combined with the \fB\-\-verbose\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
# pelican\-themes \-\-install ~/Dev/Python/pelican\-themes/notmyidea\-cms \-\-verbose
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.EX
# pelican\-themes \-\-install ~/Dev/Python/pelican\-themes/notmyidea\-cms\e
                           ~/Dev/Python/pelican\-themes/martyalchin \e
                           \-\-verbose
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.EX
# pelican\-themes \-vi ~/Dev/Python/pelican\-themes/two\-column
.EE
.UNINDENT
.UNINDENT
.SS Removing themes
.sp
The \fBpelican\-themes\fP command can also remove themes from the Pelican themes
path. The \fB\-r\fP or \fB\-\-remove\fP option takes as argument the name(s) of the
theme(s) you want to remove, and can be combined with the \fB\-\-verbose\fP option.
.INDENT 0.0
.INDENT 3.5
.sp
.EX
# pelican\-themes \-\-remove two\-column
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.EX
# pelican\-themes \-r martyachin notmyidea\-cmd \-v
.EE
.UNINDENT
.UNINDENT
.SS Creating symbolic links
.sp
\fBpelican\-themes\fP can also install themes by creating symbolic links instead
of copying entire themes into the Pelican themes path.
.sp
To symbolically link a theme, you can use the \fB\-s\fP or \fB\-\-symlink\fP, which
works exactly as the \fB\-\-install\fP option:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
# pelican\-themes \-\-symlink ~/Dev/Python/pelican\-themes/two\-column
.EE
.UNINDENT
.UNINDENT
.sp
In this example, the \fBtwo\-column\fP theme is now symbolically linked to the
Pelican themes path, so we can use it, but we can also modify it without having
to reinstall it after each modification.
.sp
This is useful for theme development:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ sudo pelican\-themes \-s ~/Dev/Python/pelican\-themes/two\-column
$ pelican ~/Blog/content \-o /tmp/out \-t two\-column
$ firefox /tmp/out/index.html
$ vim ~/Dev/Pelican/pelican\-themes/two\-column/static/css/main.css
$ pelican ~/Blog/content \-o /tmp/out \-t two\-column
$ cp /tmp/bg.png ~/Dev/Pelican/pelican\-themes/two\-column/static/img/bg.png
$ pelican ~/Blog/content \-o /tmp/out \-t two\-column
$ vim ~/Dev/Pelican/pelican\-themes/two\-column/templates/index.html
$ pelican ~/Blog/content \-o /tmp/out \-t two\-column
.EE
.UNINDENT
.UNINDENT
.SS Doing several things at once
.sp
The \fB\-\-install\fP, \fB\-\-remove\fP and \fB\-\-symlink\fP options are not mutually
exclusive, so you can combine them in the same command line to do more than one
operation at time, like this:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
# pelican\-themes \-\-remove notmyidea\-cms two\-column \e
                 \-\-install ~/Dev/Python/pelican\-themes/notmyidea\-cms\-fr \e
                 \-\-symlink ~/Dev/Python/pelican\-themes/two\-column \e
                 \-\-verbose
.EE
.UNINDENT
.UNINDENT
.sp
In this example, the theme \fBnotmyidea\-cms\fP is replaced by the theme
\fBnotmyidea\-cms\-fr\fP
.SH AUTHOR
Mickaël Raybaud
.SH COPYRIGHT
2010–2024
.\" Generated by docutils manpage writer.
.