scons-tool-dvipdfm 0.2.0

Dvipdfm tool for SCons

This is dvipdfm tool for SCons. It is derived from the dvipdf tool present in SCons core. The code has been adapted to enable usage of dvipdfm program.

Installation

There are few ways to install this tool for your project.

From pypi

This method may be preferable if you build your project under a virtualenv. To add dvipdfm tool from pypi, type (within your wirtualenv):

pip install scons-tool-loader scons-tool-dvipdfm

or, if your project uses pipenv:

pipenv install --dev scons-tool-loader scons-tool-dvipdfm

Alternatively, you may add this to your Pipfile

[dev-packages]
scons-tool-loader = "*"
scons-tool-dvipdfm = "*"

The tool will be installed as a namespaced package sconstool.dvipdfm in project’s virtual environment. You may further use scons-tool-loader to load the tool.

As a git submodule

1. Create new git repository:

   mkdir /tmp/prj && cd /tmp/prj
   touch README.rst
   git init

2. Add the scons-tool-dvipdfm as a submodule:

   git submodule add git://github.com/ptomulik/scons-tool-dvipdfm.git site_scons/site_tools/dvipdfm

3. For python 2.x create __init__.py in site_tools directory:

   touch site_scons/site_tools/__init__.py

   this will allow to directly import site_tools.dvipdfm (this may be required by other tools).

Usage examples

Converting existing *.dvi file to *.pdf:

# SConstruct
env = Environment(tools=['dvipdfm'])
env.DVIPDFM('foo.dvi')

Compiling LaTeX document to *.dvi and generating *.pdf file with the DVIPDFM builder (note, the tex or default tool(s) must be loaded):

# SConstruct
env = Environment(tools=['tex', 'dvipdfm'])
env.DVIPDFM('foo.tex')

Construction variables

The following construction variables may be used to configure the DVIPDFM builder:

Variable	Description
DVIPDFM	the dvipdfm executable
DVIPDFMFLAGS	additional flags to dvipdfm
DVIPDFMCOM	complete commandline for dvipdfm
DVIPDFMSUFFIX	suffix for target files, by default .pdf

LICENSE

Copyright (c) 2013-2020 by Paweł Tomulik

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE