--- naturaldocs-1.35+devel.2007.12.07.orig/naturaldocs.1 +++ naturaldocs-1.35+devel.2007.12.07/naturaldocs.1 @@ -0,0 +1,94 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH NATURALDOCS 1 "May 2007" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +NaturalDocs \- an extensible, multi\-language documentation generator +.SH SYNOPSIS +.ad l +.B naturaldocs +-i [-i ...] -o [-o ...] -p [options] +.ad b +.SH DESCRIPTION +This manual page documents briefly the .B naturaldocs command. Note that \fBnaturaldocs\fP is a wrapper script that on Debian invokes the real \fBNaturalDocs\fP perl program. So, the real, original name of the program is NaturalDocs but on +Debian systems you invoke it as naturaldocs. +.PP +\fBNatural Docs\fP is is an open-source, extensible, multi-language documentation generator. You document your code in a natural syntax that reads like plain English. Natural Docs then scans your code and builds high-quality HTML documentation from it. +.SH OPTIONS +A summary of options, extracted from the help printed by the \fB-h\fP +switch is included below. +For a complete description of how NaturalDocs works, see the text +files in the /usr/share/doc/naturaldocs directory. +.sp +\fIRequired parameters\fR: +.TP +.B \-i, \-\-input, \-\-source DIR +Specifies an input (source) directory. Required. +.br +Can be specified multiple times. +.TP +.B \-o, \-\-output FMT DIR +Specifies an output format and directory. Required. +.br +Can be specified multiple times, but only once per directory. Possible output formats are HTML and FramedHTML. +.TP +.B \-p, \-\-project DIR +Specifies the project directory. Required. +.br +There needs to be a unique project directory for every source directory. +.sp +.PP +\fIOptional parameters\fR: +.TP +.B \-s, \-\-style STYLE [STYLE ...] +Specifies the CSS style when building HTML output. If multiple styles are specified, they will all be included in the order given. +.TP +.B \-img, \-\-image DIR +Specifies an image directory. Can be specified multiple times. Start with \fB*\fP to specify a relative directory, as in -img */images. +.TP +.B \-do, \-\-documented\-only +Specifies only documented code aspects should be included in the output. +.TP +.B \-t, \-\-tab\-length LEN +Specifies the number of spaces tabs should be expanded to. This only needs to be set if you use tabs in example code and text diagrams. Defaults to 4. +.TP +.B \-xi, \-\-exclude\-input, \-\-exclude\-source +Excludes an input (source) directory from the documentation. Automatically done for the project and output directories. Can be specified multiple times. +.TP +.B \-nag, \-\-no\-auto\-group +Turns off auto-grouping completely. +.TP +.B \-oft, \-\-only\-file\-titles +Source files will only use the file name as the title. +.TP +.B \-r, \-\-rebuild +Rebuilds all output and data files from scratch. Does not affect the menu file. +.TP +.B \-ro, \-\-rebuild\-output +Rebuilds all output files from scratch. +.TP +.B \-q, \-\-quiet +Suppresses all non-error output. +.TP +.B \-?, \-h, \-\-help +Displays syntax reference. +.br +.SH AUTHOR +NaturalDocs was written by Greg Valure . +.PP +This manual page was written by Federico Di Gregorio , +for the Debian project (but may be used by others). + --- naturaldocs-1.35+devel.2007.12.07.orig/naturaldocs +++ naturaldocs-1.35+devel.2007.12.07/naturaldocs @@ -0,0 +1,3 @@ +#!/bin/sh +exec /usr/bin/perl /usr/share/perl5/naturaldocs/NaturalDocs $@ + --- naturaldocs-1.35+devel.2007.12.07.orig/debian/changelog +++ naturaldocs-1.35+devel.2007.12.07/debian/changelog @@ -0,0 +1,18 @@ +naturaldocs (1.35+devel.2007.12.07-2) unstable; urgency=low + + * Removed "open source" from the packages description (fixes: #458557) + + -- Federico Di Gregorio Tue, 01 Jan 2008 17:42:33 +0100 + +naturaldocs (1.35+devel.2007.12.07-1) unstable; urgency=low + + * New upstream release. + + -- Federico Di Gregorio Fri, 28 Dec 2007 20:15:39 +0100 + +naturaldocs (1.35+devel.2007.02.10-1) unstable; urgency=low + + * Initial release (Closes: #422086) + + -- Federico Di Gregorio Thu, 3 May 2007 15:35:39 +0200 + --- naturaldocs-1.35+devel.2007.12.07.orig/debian/rules +++ naturaldocs-1.35+devel.2007.12.07/debian/rules @@ -0,0 +1,75 @@ +#!/usr/bin/make -f +# -*- makefile -*- +# +# This file was originally written by Joey Hess and Craig Small. +# As a special exception, when this file is copied by dh-make into a +# dh-make output file, you may use that output file without restriction. +# This special exception was added by Craig Small in version 0.37 of dh-make. + +# Uncomment this to turn on verbose mode. +#export DH_VERBOSE=1 + +CFLAGS = -Wall -g + +ifneq (,$(findstring noopt,$(DEB_BUILD_OPTIONS))) + CFLAGS += -O0 +else + CFLAGS += -O2 +endif + +perlmoddir = /usr/share/perl5 + +configure: configure-stamp +configure-stamp: + dh_testdir + touch configure-stamp + + +build: build-stamp + +build-stamp: configure-stamp + dh_testdir + touch $@ + +clean: + dh_testdir + dh_testroot + rm -f build-stamp configure-stamp + rm -fr debian/naturaldocs + dh_clean + +install: build + dh_testdir + dh_testroot + dh_clean -k + dh_installdirs + cp -ra Modules Config JavaScript Styles NaturalDocs \ + debian/naturaldocs/$(perlmoddir)/naturaldocs + cp -ra Info/* debian/naturaldocs/usr/share/doc/naturaldocs + install -m 755 naturaldocs debian/naturaldocs/usr/bin + +# Build architecture-independent files here. +binary-indep: build install +# We have nothing to do by default. + +# Build architecture-dependent files here. +binary-arch: build install + dh_testdir + dh_testroot + dh_installchangelogs + dh_installdocs +# dh_install + dh_installman + dh_link + dh_strip + dh_compress + dh_fixperms + dh_perl + dh_installdeb + dh_shlibdeps + dh_gencontrol + dh_md5sums + dh_builddeb + +binary: binary-indep binary-arch +.PHONY: build clean binary-indep binary-arch binary install configure --- naturaldocs-1.35+devel.2007.12.07.orig/debian/compat +++ naturaldocs-1.35+devel.2007.12.07/debian/compat @@ -0,0 +1 @@ +5 --- naturaldocs-1.35+devel.2007.12.07.orig/debian/copyright +++ naturaldocs-1.35+devel.2007.12.07/debian/copyright @@ -0,0 +1,38 @@ +This package was debianized by: + + Federico Di Gregorio on Thu, 3 May 2007 15:35:39 +0200. + +It was downloaded from: + + http://www.naturaldocs.org/ + +Upstream Author: + + Greg Valure + +Copyright: + + Copyright (C) 2003-2006 Greg Valure + +License: + + This package is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This package is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this package; if not, write to the Free Software + Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +On Debian systems, the complete text of the GNU General +Public License can be found in `/usr/share/common-licenses/GPL'. + +The Debian packaging is (C) 2007, Federico Di Gregorio and +is licensed under the GPL, see above. + --- naturaldocs-1.35+devel.2007.12.07.orig/debian/control +++ naturaldocs-1.35+devel.2007.12.07/debian/control @@ -0,0 +1,16 @@ +Source: naturaldocs +Section: devel +Priority: extra +Maintainer: Federico Di Gregorio +Build-Depends: debhelper (>= 5) +Standards-Version: 3.7.3 + +Package: naturaldocs +Architecture: all +Depends: ${perl:Depends} +Description: an extensible, multi-language documentation generator + Natural Docs is an extensible, multi-language documentation + generator. You document your code in a natural syntax that reads + like plain English. Natural Docs then scans your code and builds + high-quality HTML documentation from it. + --- naturaldocs-1.35+devel.2007.12.07.orig/debian/dirs +++ naturaldocs-1.35+devel.2007.12.07/debian/dirs @@ -0,0 +1,4 @@ +usr/bin +usr/share/perl5/naturaldocs +usr/share/doc/naturaldocs +