[people/ms/dma.git] / debian / migrate / dma-migrate.8

.\" Copyright (c) 2010  Peter Pentchev
.\" 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 AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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 May 11, 2009
.Dt dma-migrate 8
.Os
.Sh NAME
.Nm dma-migrate
.Nd convert the DragonFly Mail Agent's queue files
.Sh SYNOPSIS
.Nm
.Op Fl v
.Op Fl d Ar spooldir
.Nm
.Op Fl h | Fl V
.Sh DESCRIPTION
The
.Nm
utility is used to convert the mail queue files in the
.Xr dma 8
spool directory to the latest spool directory format supported by
the installed version of
.Xr dma 8 .
Currently it only handles the conversion from a single file containing
both message and delivery metadata to the M/Q format.
.Pp
The following command-line options are available:
.Bl -tag -width indent
.It Fl d
Specify the location of the
.Xr dma 8
spool directory, default
.Pa /var/spool/dma .
.It Fl h
Display usage information and exit.
.It Fl V
Display program version information and exit.
.It Fl v
Verbose output - display diagnostic messages.
.El
.Sh ENVIRONMENT
The operation of the
.Nm
utility is currently not influenced by environment variables.
.Sh FILES
The
.Nm
utility looks for the
.Xr dma 8
mail queue files in the
.Pa /var/spool/dma
directory, unless another location is specified by the
.Fl d
command-line option.
.Sh EXIT STATUS
The
.Nm
utility will scan the whole spool directory and attempt to convert all
suitable files there.
If there are no files to be converted, or if all the conversions are
successful, it will complete with an exit code of zero.
If any conversion errors are encountered, a message will be displayed
to the standard error stream and
.Nm
will exit with an exit code of 1 after attempting to convert the rest of
the suitable files in the spool directory.
.Sh SEE ALSO
.Xr dma 8
.Sh STANDARDS
No standards documentation was harmed in the process of creating
.Nm .
.Sh BUGS
Please report any bugs in
.Nm
to the author.
.Sh AUTHOR
.An Peter Pentchev Aq roam@ringlet.net
Commit	Line	Data
d873a142 PP	1	.\" Copyright (c) 2010 Peter Pentchev
	2	.\" All rights reserved.
	3	.\"
	4	.\" Redistribution and use in source and binary forms, with or without
	5	.\" modification, are permitted provided that the following conditions
	6	.\" are met:
	7	.\" 1. Redistributions of source code must retain the above copyright
	8	.\" notice, this list of conditions and the following disclaimer.
	9	.\" 2. Redistributions in binary form must reproduce the above copyright
	10	.\" notice, this list of conditions and the following disclaimer in the
	11	.\" documentation and/or other materials provided with the distribution.
	12	.\"
	13	.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
	14	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	15	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	16	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
	17	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	18	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	19	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	20	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	21	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	22	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	23	.\" SUCH DAMAGE.
	24	.\"
	25	.Dd May 11, 2009
	26	.Dt dma-migrate 8
	27	.Os
	28	.Sh NAME
	29	.Nm dma-migrate
	30	.Nd convert the DragonFly Mail Agent's queue files
	31	.Sh SYNOPSIS
	32	.Nm
	33	.Op Fl v
	34	.Op Fl d Ar spooldir
	35	.Nm
	36	.Op Fl h \| Fl V
	37	.Sh DESCRIPTION
	38	The
	39	.Nm
	40	utility is used to convert the mail queue files in the
	41	.Xr dma 8
	42	spool directory to the latest spool directory format supported by
	43	the installed version of
	44	.Xr dma 8 .
	45	Currently it only handles the conversion from a single file containing
	46	both message and delivery metadata to the M/Q format.
	47	.Pp
	48	The following command-line options are available:
	49	.Bl -tag -width indent
	50	.It Fl d
	51	Specify the location of the
	52	.Xr dma 8
	53	spool directory, default
	54	.Pa /var/spool/dma .
	55	.It Fl h
	56	Display usage information and exit.
	57	.It Fl V
	58	Display program version information and exit.
	59	.It Fl v
	60	Verbose output - display diagnostic messages.
	61	.El
	62	.Sh ENVIRONMENT
	63	The operation of the
	64	.Nm
65	utility is currently not influenced by environment variables.
66	.Sh FILES
67	The
68	.Nm
69	utility looks for the
70	.Xr dma 8
71	mail queue files in the
72	.Pa /var/spool/dma
73	directory, unless another location is specified by the
74	.Fl d
75	command-line option.
76	.Sh EXIT STATUS
77	The
78	.Nm
79	utility will scan the whole spool directory and attempt to convert all
80	suitable files there.
81	If there are no files to be converted, or if all the conversions are
82	successful, it will complete with an exit code of zero.
83	If any conversion errors are encountered, a message will be displayed
84	to the standard error stream and
85	.Nm
86	will exit with an exit code of 1 after attempting to convert the rest of
87	the suitable files in the spool directory.
88	.Sh SEE ALSO
89	.Xr dma 8
90	.Sh STANDARDS
91	No standards documentation was harmed in the process of creating
92	.Nm .
93	.Sh BUGS
94	Please report any bugs in
95	.Nm
96	to the author.
97	.Sh AUTHOR
98	.An Peter Pentchev Aq roam@ringlet.net