.\"
.\"	Man page for `yencode'
.\"
.\"	$Header: /pub/cvsroot/yencode/doc/yencode.1,v 1.7 2002/03/21 04:58:31 bboy Exp $
.\"
.\"	Copyright (C) 2002  Don Moore <bboy@bboy.net>
.\"
.\"	Process this file with `groff -man -Tascii yencode.1'
.\"
.TH yencode 1 "March 2002" yencode "User Commands"
.SH NAME
yencode \- Usenet file encoder
.SH SYNOPSIS
.B yencode
[\fB-d\fP, \fB--debug\fP]
[\fB-e\fP, \fB--extension=\fP\fIext\fP]
[\fB-f\fP, \fB--force\fP]
[\fB-l\fP, \fB--line=\fP\fIlength\fP]
[\fB-m\fP, \fB--multipart=\fP\fIsize\fP]
[\fB-o\fP, \fB--output=\fP\fIdir\fP]
[\fB-p\fP, \fB--paths\fP]
[\fB-q\fP, \fB--quiet\fP]
[\fB--sfv=\fP\fIname\fP]
[\fB--crc=\fP\fIname\fP]
[\fB--help\fP]
[\fB--version\fP]
\fBFILE\fP \fB...\fP

.\"
.\"  DESCRIPTION
.\"
.SH DESCRIPTION
\fByencode\fP encodes the files specified on the command line according to the yEnc Usenet encoding
format.

.\"
.\"  OPTIONS
.\"
.SH OPTIONS
.IP "\fB-d\fP, \fB--debug\fP"
Write messages useful for debugging to stderr while program is operating.

.IP "\fB-e\fP, \fB--extension\fP=\fIext\fP"
Use \fIext\fP as the file extension for encoded files, instead of \fIync\fP, which is the default.

.IP "\fB-f\fP, \fB--force\fP"
If the output file already exists, overwrite the existing file without prompting.

.IP "\fB-l\fP, \fB--line\fP=\fIlength\fP"
Create encoded lines of \fIlength\fP characters, instead of 128, which is the default.

.IP "\fB-m\fP, \fB--multipart\fP=\fIsize\fP"
Create multipart output, with each file containing \fIsize\fP bytes of data.  \fIsize\fP may be
specified in bytes, or in a human-friendly format such as \fI200k\fP or \fI2M\fP.  If \fB-m\fP is
specified without a size, each part defaults to 620k.

.IP "\fB-o\fP, \fB--output\fP=\fIdir\fP"
Create output in \fIdir\fP instead of the current directory.

.IP "\fB-p\fP, \fB--paths\fP"
Save relative pathnames to files in the encoded data.  For example, running \fByencode files/new/bigfile.mp3\fP
will by default save the filename as \fBbigfile.mp3\fP.  If the \fB-p\fP option is specified, the filename
will be saved as \fBfiles/new/bigfile.mp3\fP.

.IP "\fB-q\fP, \fB--quiet\fP"
Try to avoid writing output while running.  The only output that will occur is error messages.

.IP "\fB--sfv\fP=\fIname\fP"
Create a yencoded SFV file containing the checksum of each input file.  If \fIname\fP is specified, then that name will
be used as a prefix for the SFV file.

.IP "\fB--crc\fP=\fIname\fP"
Create a yencoded CRC file containing the checksum of each input file.  If \fIname\fP is specified, then that name will
be used as a prefix for the CRC file.  Note that this CRC file may or may not comply with the "standard" for what a 
\fB.crc\fP file is supposed to contain.

.IP "\fB--help\fP"
Display program help and exit.

.IP "\fB--version\fP"
Output version number and exit.


.\"
.\"  AUTHOR
.\"
.SH AUTHOR
Don Moore <bboy@bboy.net>


.\"
.\"  HOMEPAGE
.\"
.SH HOMEPAGE
http://www.yencode.org/


.\"
.\"  SEE ALSO
.\"
.SH "SEE ALSO"
.BR ydecode (1),
.BR ypost (1)