Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

eric4_doc(1) [debian man page]

ERIC4_DOC(1)						      General Commands Manual						      ERIC4_DOC(1)

NAME
eric4_doc - eric4 documentation generator SYNOPSIS
eric4_doc [options] files... where files can be be either Python modules, package directories or ordinary directories. DESCRIPTION
This manual page documents briefly the eric4_doc command. This manual page was written for the Debian distribution because the original program does not have a manual page. Instead, it has documentation provided in the file /usr/share/doc/eric/README-eric4-doc.txt.gz in plain text format. eric4_doc is the documentation generator of the eric4 IDE. Source code documentation may be included as ordinary Python doc-strings or as documentation comments. For Quixote Template file (PTL) only documentation comments are available due to the inner workings of Quixote. Documentation comments start with the string ###, followed by the contents and ended by ###. Every line of the documentation comments con- tents must start with a # (see example below). OPTIONS
These programs follow the usual GNU command line syntax, with long options starting with two dashes (`-'). A summary of options is included below. For a complete description, see the Info files. -p prefix or --prefix=prefix Prepend given prefix to file names. -o directory or --outdir=directory Generate files in the named directory. -R, -r or --recursive Perform a recursive search for Python files. -x directory or --exclude=directory Specify a directory basename to be excluded. This option may be repeated multiple times. -i or --noindex Don't generate index files. -e or --noempty Don't include empty modules. -h, --help Show summary of options. -v, --version Show version of program. SEE ALSO
eric4(1), eric4_api(1), eric4_compare(1), eric4_configure(1), eric4_diff(1), eric4_editor(1), eric4_helpviewer(1), eric4_iconeditor(1), eric4_plugininstall(1), eric4_pluginrepository(1), eric4_pluginuninstall(1), eric4_qregexp(1), eric4_re(1), eric4_sqlbrowser(1), eric4_tray(1), eric4_trpreviewer(1), eric4_uipreviewer(1), eric4_unittest(1), eric4_webbrowser(1) AUTHOR
This manual page was written by Torsten Marek <shlomme@gmx.net>, for the Debian project (but may be used by others). January 31, 2010 ERIC4_DOC(1)

Check Out this Related Man Page

DH_INSTALLDOCS(1)						     Debhelper							 DH_INSTALLDOCS(1)

NAME
dh_installdocs - install documentation into package build directories SYNOPSIS
dh_installdocs [debhelperoptions] [-A] [-Xitem] [file...] DESCRIPTION
dh_installdocs is a debhelper program that is responsible for installing documentation into usr/share/doc/package in package build directories. FILES
debian/package.docs List documentation files to be installed into package. debian/copyright The copyright file is installed into all packages, unless a more specific copyright file is available. debian/package.copyright debian/package.README.Debian debian/package.TODO Each of these files is automatically installed if present for a package. debian/README.Debian debian/TODO These files are installed into the first binary package listed in debian/control. Note that README.debian files are also installed as README.Debian, and TODO files will be installed as TODO.Debian in non-native packages. debian/package.doc-base Installed as doc-base control files. Note that the doc-id will be determined from the Document: entry in the doc-base control file in question. debian/package.doc-base.* If your package needs to register more than one document, you need multiple doc-base files, and can name them like this. OPTIONS
-A, --all Install all files specified by command line parameters in ALL packages acted on. -Xitem, --exclude=item Exclude files that contain item anywhere in their filename from being installed. Note that this includes doc-base files. --link-doc=package Make the documentation directory of all packages acted on be a symlink to the documentation directory of package. This has no effect when acting on package itself, or if the documentation directory to be created already exists when dh_installdocs is run. To comply with policy, package must be a binary package that comes from the same source package. debhelper will try to avoid installing files into linked documentation directories that would cause conflicts with the linked package. The -A option will have no effect on packages with linked documentation directories, and copyright, changelog, README.Debian, and TODO files will not be installed. (An older method to accomplish the same thing, which is still supported, is to make the documentation directory of a package be a dangling symlink, before calling dh_installdocs.) file ... Install these files as documentation into the first package acted on. (Or in all packages if -A is specified). EXAMPLES
This is an example of a debian/package.docs file: README TODO debian/notes-for-maintainers.txt docs/manual.txt docs/manual.pdf docs/manual-html/ NOTES
Note that dh_installdocs will happily copy entire directory hierarchies if you ask it to (similar to cp -a). If it is asked to install a directory, it will install the complete contents of the directory. Note that this command is not idempotent. dh_prep(1) should be called between invocations of this command. Otherwise, it may cause multiple instances of the same text to be added to maintainer scripts. SEE ALSO
debhelper(7) This program is a part of debhelper. AUTHOR
Joey Hess <joeyh@debian.org> 9.20120909 2011-09-12 DH_INSTALLDOCS(1)
Man Page

Featured Tech Videos