summaryrefslogtreecommitdiff
path: root/docs/index.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/index.html')
-rw-r--r--docs/index.html140
1 files changed, 140 insertions, 0 deletions
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 00000000..3a773d21
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,140 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>MuPDF Documentation</title>
+<link rel="stylesheet" href="style.css" type="text/css">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+</head>
+
+<body>
+
+<header>
+<h1>MuPDF Documentation</h1>
+</header>
+
+<nav>
+<a href="http://mupdf.com/index.html">ABOUT</a>
+<a href="http://mupdf.com/news.html">NEWS</a>
+<a href="index.html">DOCUMENTATION</a>
+<a href="http://mupdf.com/downloads/">DOWNLOAD</a>
+<a href="http://git.ghostscript.com/?p=mupdf.git;a=summary">SOURCE</a>
+<a href="https://bugs.ghostscript.com/">BUGS</a>
+</nav>
+
+<article>
+
+<p>
+MuPDF is an open source software framework for viewing and converting PDF, XPS, and E-book documents.
+There are viewers for various platforms,
+several command line tools,
+and a software library for building tools and applications.
+
+<h2>Viewers</h2>
+
+<p>
+For Linux and Windows there are two viewers. One is a very basic viewer using x11 and win32, respectively.
+It has been supplanted by a newer viewer using OpenGL for rendering, which has more features
+such as table of contents, unicode search, etc.
+We keep the old viewers around for older systems where OpenGL is not available.
+
+<p>
+Read the <a href="manual-mupdf-gl.html">manual for the new Linux and Windows viewer</a>.
+
+<p>
+Android currently has several different viewers with varying degrees of complexity:
+
+<dl>
+<dt><a href="https://play.google.com/store/apps/details?id=com.artifex.mupdf.mini">MuPDF mini</a>
+<dd>A minimal code example of a document viewer.
+<dt><a href="https://play.google.com/store/apps/details?id=com.artifex.mupdfdemo">MuPDF demo</a>
+<dd>The main app on Google Play. Supports forms and annotations.
+<dt>MuPDF NUI
+<dd>A viewer that matches the look & feel of SmartOffice. This product is still in early development.
+</dl>
+
+<p>
+The iOS viewer is available on the <a href="https://itunes.apple.com/us/app/mupdf/id482941798">App Store</a>.
+
+<h2>Command Line Tools</h2>
+
+<p>
+The command line tools are all gathered into one umbrella command: mutool.
+
+<p>
+For rendering and converting documents there are two commands available:
+
+<dl>
+<dt><a href="manual-mutool-draw.html">mutool draw</a>
+<dd>This is the more customizable tool, but also has a more difficult set of command line options.
+It is primarily used for rendering a document to image files.
+<dt><a href="manual-mutool-convert.html">mutool convert</a>
+<dd>This tool is used for converting documents into other formats, and is easier to use.
+</dl>
+
+<p>
+There are also several tools specifically for working with PDF files:
+
+<dl>
+<dt><a href="manual-mutool-show.html">mutool show</a>
+<dd>A tool for displaying the internal objects in a PDF file.
+<dt><a href="manual-mutool-extract.html">mutool extract</a>
+<dd>Extract images and embedded font resources.
+<dt><a href="manual-mutool-clean.html">mutool clean</a>
+<dd>Rewrite PDF file. Used to fix broken files, or to make a PDF file human editable.
+<dt><a href="manual-mutool-merge.html">mutool merge</a>
+<dd>Merge pages from multiple input files into a new PDF.
+<dt><a href="manual-mutool-create.html">mutool create</a>
+<dd>Create a new PDF file from a text file with graphics commands.
+<dt><a href="manual-mutool-portfolio.html">mutool portfolio</a>
+<dd>Manipulate PDF portfolios.
+</dl>
+
+<p>
+And finally, there is a tool for doing anything you can imagine:
+
+<dl>
+<dt><a href="manual-mutool-run.html">mutool run</a>
+<dd>A tool for running Javascript programs with access to the MuPDF library functions.
+</dl>
+
+<h2>Library</h2>
+
+<p>
+The library is written in portable C.
+<!--
+To learn more about the C interface, read the <a href="book/nav.xhtml">MuPDF Explored</a> book.
+The book is also available as a <a href="book.pdf">PDF</a> and <a href="book.epub">EPUB</a> file.
+-->
+
+<ul>
+<li><a href="building.html">How to build the library</a>.
+<li><a href="coding-overview.html">Overview</a>.
+<li><a href="coding-style.html">Coding style</a>.
+<li><a href="coding-progressive.html">Progressive loading</a>.
+<li><a href="thirdparty.html">List of third party libraries</a>.
+</ul>
+
+<p>
+There is also a Java library, which uses JNI to provide access to the C library.
+The Java classes provide an interface very similar to that available in the
+<a href="manual-mutool-run.html">mutool run</a> command line tool.
+This Java library is also how you use MuPDF on Android.
+
+<p>
+If you want to build an application for Android, you have several options. You can base it off one of
+the existing viewers, or build a new app using the Java library directly.
+
+<ul>
+<li><a href="android-build-viewer.html">How to build the Android viewer</a>.
+<li><a href="android-build-library.html">How to build the Android library</a>.
+</ul>
+
+</article>
+
+<footer>
+<a href="http://artifex.com"><img src="artifex-logo.png" align="right"></a>
+Copyright &copy; 2006-2017 Artifex Software Inc.
+</footer>
+
+</body>
+</html>