Import of pkgsrc-2014Q1

security/multigest/files/multigest.1

@@ -0,0 +1,111 @@
+.\" $NetBSD: multigest.1,v 1.1.1.1 2014/03/05 05:09:44 agc Exp $
+.\"
+.\" Copyright (c) 2013 Alistair Crooks <agc@NetBSD.org>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd August 17, 2013
+.Dt MULTIGEST 1
+.Os
+.Sh NAME
+.Nm multigest
+.Nd calculate multiple message digests simultaneously
+.Sh SYNOPSIS
+.Nm
+.Fl r
+.Op Fl a Ar algorithms
+.Op Fl c Ar digestfile
+.Op Fl F Ar output-format
+.Op Fl o Ar output
+.Op Fl S Ar output-separator
+.Op Fl s Ar /regex/replacement/
+.Op file ...
+.Sh DESCRIPTION
+The
+.Nm
+utility calculates message digests of files or,
+if no file is specified, standard input.
+The list of possible algorithms is given in the
+.Xr libmultigest 3
+manual page.
+.Pp
+The
+.Nm
+utility is a simple wrapper for the various different
+algorithm implementations, which are located in the standard
+C library, and was designed to be scalable as new message digest
+algorithms are developed.
+.Pp
+The
+.Nm
+utility uses the
+.Xr libmultigest 3
+library.
+.Pp
+The following options are available:
+.Bl -tag -width XregexXreplacementXYYY
+.It Fl a Ar algorithms
+specify a comma-separated list of algorithms to be calculated
+.It Fl c Ar stored-digest-file
+check, or verify, a file containing previously-generated digests
+.It Fl F Ar output-format
+print the output in the format requested.
+Possible values are
+.Dq openssl ,
+.Dq digest ,
+and
+.Dq multigest .
+The default is
+.Dq multigest
+which means that any replacement text is printed in a separate field.
+.It Fl o Ar output-file
+write the calculated digests to the output file
+.It Fl r
+shorthand for input substitution for the RCS Identifiers
+.Dq Id
+and
+.Dq NetBSD
+.It Fl S Ar output-separator
+separate each individual digest on output with the provided string.
+The output separator defaults to the null string, i.e. no separator.
+.It Fl s Ar /regex/replacement/
+before calculating digests, run the following transformation on the input
+to normalise any input.
+Using this, the effects of expanding version control system
+identifiers is nullified.
+.El
+.Pp
+If no input files are provided, input is taken from standard input.
+.Sh EXIT STATUS
+.Ex -std multigest
+.Sh SEE ALSO
+.Xr libmultigest 3
+.Sh HISTORY
+The
+.Nm
+utility first appeared in
+.Nx 7.0 .
+.Sh AUTHORS
+The
+.Nm
+utility was written by
+.An Alistair G. Crooks Aq Mt agc@netbsd.org .