\input texinfo   @c -*-texinfo-*-
@c %**start of header
@setfilename dsmcheck.info
@settitle 
@setchapternewpage odd
@paragraphindent 0
@c %**end of header

@c $Id: dsmcheck.txi,v 1.8 2002/06/23 20:28:30 richdawe Exp $

@include version.txi

@titlepage
@title dsmcheck @value{DSMCHECK-VERSION} Manual
@subtitle Copyright @copyright{} @value{DSMCHECK-COPYRIGHT-YEARS} by Richard Dawe
@page
@end titlepage

@ifinfo
@dircategory DJGPP Package Management
@direntry
* dsmcheck: (dsmcheck).       dsmcheck, a DJGPP Software Manifest checker
@end direntry
@end ifinfo

@node Top, Introduction, (dir), (dir)
@top

@c Author: Richard Dawe @email{rich@@phekda.freeserve.co.uk}

@ifnottex

dsmcheck @value{DSMCHECK-VERSION} Manual
Copyright @copyright{} @value{DSMCHECK-COPYRIGHT-YEARS} by Richard Dawe

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1
or any later version published by the Free Software Foundation;
with no Invariant Sections, with no Front-Cover Texts, and with no
Back-Cover Texts. A copy of the license is included in the section
entitled "GNU Free Documentation License"
(@pxref{GNU Free Documentation License}).

@menu
* Introduction::

* GNU Free Documentation License::

* Concept Index::
@end menu

@end ifnottex

@node Introduction, GNU Free Documentation License, Top, Top
@chapter Introduction

dsmcheck is a syntax checker for DJGPP Software Manifests (DSMs).  It checks
that DSMs comply with the DSM specification (@pxref{Top, , dsm.inf}).  DSMs
are used by pakke (@pxref{Top, , pakke.inf}) to manage packages.

pakke is simple to invoke:

@example
dsmcheck <DSM file> [<DSM file> ...]
@end example

dsmcheck can read DSM files from archives, so it can be invoked on package
files.

dsmcheck will produce a list of errors in the DSM file(s) specified, if any.
For example:

@example
bash-2.04$ dsmcheck baaad2.dsm
baaad2.dsm: Line 1: Bad directive 'dsm-file-version:'
baaad2.dsm: Line 2: Bad directive '1.0'
baaad2.dsm: Required directive 'dsm-author' missing
baaad2.dsm: Required directive 'dsm-file-version' missing
baaad2.dsm: Required directive 'dsm-version' missing
baaad2.dsm: Required directive 'dsm-name' missing
baaad2.dsm: Required directive 'dsm-type' missing
baaad2.dsm: Required directive 'name' missing
baaad2.dsm: Required directive 'version' missing
baaad2.dsm: Required directive 'short-description' missing
baaad2.dsm: Required directive 'zip' missing
@end example

You may need to run dsmcheck several times, when correcting parsing errors.

@node GNU Free Documentation License, Concept Index, Introduction, Top
@appendix GNU Free Documentation License

@include fdl.txi

@node Concept Index, , GNU Free Documentation License, Top
@unnumbered Concept Index

@printindex cp

@contents
@bye
