.\" -*- nroff -*-
.TH pdfoutline 1 @DATE@
.SH NAME
pdfoutline \- add outlines (aka bookmarks) to PDF files
\" macros
.de SAMPLE
.br
.RS
.nf
.nh
..
.de ESAMPLE
.hy
.fi
.RE
..
.SH SYNOPSIS
.B pdfoutline
.I input.pdf outlines.txt output.pdf
.SH DESCRIPTION
\fBpdfoutline\fP reads input file given as first argument, adds outlines from text file given
as second argument, and saves result to file with name given as third argument.
.P
File with outlines information should consist of lines in the following format:
.SAMPLE
\fI<level>\fP \fI<page>\fP Outline text
.ESAMPLE
.P
\fI<level>\fP and \fI<page>\fP should be integers.
Each field should be separated by exactly one space symbol.
All values for \fI<level>\fP should be greater or equal than that of the first line.
Page numeration starts with 1.
.P
Outlines file can contain comments that start with # in first column.
Comments and empty lines are ignored.
The text is expected to be in UTF-8 encoding.
.SH OPTIONS
.B pdfoutline
accepts no options.
.SH EXAMPLES
Here is example of outlines data file:
.SAMPLE
0 1 Document title
1 1 Chapter 1
2 1 Chapter 1.1
2 2 Chapter 1.2
1 3 Chapter 2
.ESAMPLE
.P
Using this file will result in outlines like the following:
.SAMPLE
Document title
+-Chapter 1
| +-Chapter 1.1
| +-Chapter 1.2
+-Chapter 2
.ESAMPLE
.SH AUTHOR
.B pdfoutline
author is Eugeniy Meshcheryakov <eugen@debian.org>
.br
\fBpdfoutline\fP is part of \fBfntsample\fP and can be downoaded from
<https://github.com/eugmes/fntsample>.
