ablog/docs/manual/ablog-commands.rst

.. _commands:



ABlog Commands
==============

.. post:: Feb 1, 2015
   :tags: config
   :author: Ahmet, Mehmet
   :category: Manual
   :location: SF


`ablog` command is designed to streamline blog operations, i.e.
building, serving, and viewing blog pages, as well as starting a new
blog.


::

  $ ablog
  usage: ablog [-h] [-v] {start,build,serve,post} ...

  ABlog for blogging with Sphinx

  optional arguments:
    -h, --help            show this help message and exit
    -v, --version         print ABlog version and exit

  subcommands:
    {start,build,serve,post}
      start               start a new blog project
      build               build your blog project
      serve               serve and view your project
      post                create a blank post

  See 'ablog <command> -h' for more information on a specific command.


Start a Project
---------------


::

  $ ablog start -h
  usage: ablog start [-h]

  optional arguments:
    -h, --help  show this help message and exit



Build Website
-------------


::

  $ ablog build -h
  usage: ablog build [-h] [-b BUILDER] [-d DOCTREES] [-s SOURCEDIR] [-w WEBSITE]
                     [-T]

  Build options can be set in conf.py. Default values of paths are relative to
  conf.py.

  optional arguments:
    -h, --help    show this help message and exit
    -b BUILDER    builder to use, default `ablog_builder` or dirhtml
    -d DOCTREES   path for the cached environment and doctree files, default
                  `ablog_doctrees` or _doctrees
    -s SOURCEDIR  root path for source files, default is path to the folder that
                  contains conf.py
    -w WEBSITE    path for website, default `ablog_website` or _website
    -T            show full traceback on exception

Serve and View
--------------

::

  $ ablog serve -h
  usage: ablog serve [-h] [-n] [-p PORT] [-w WEBSITE]

  Serve options can be set in conf.py. Default values of paths are relative to
  conf.py.

  optional arguments:
    -h, --help  show this help message and exit
    -n          do not open website in a new browser tab
    -p PORT     port number for HTTP server; default is 8000
    -w WEBSITE  path for website, default `ablog_website` or _website

Create a Post
-------------

::

  $ ablog post -h
  usage: ablog post [-h] [-t TITLE] filename

  positional arguments:
    filename    filename, e.g. my-nth-post.rst

  optional arguments:
    -h, --help  show this help message and exit
    -t TITLE    post title; default is `New Post`