doc/pwmd-dump.1.in

   1 .\" Copyright (C) 2015, 2016
   2 .\" Ben Kibbey <bjk@luxsci.net>
   3 .\"
   4 .\" This file is part of pwmd.
   5 .\"
   6 .\" Pwmd is free software: you can redistribute it and/or modify
   7 .\" it under the terms of the GNU General Public License as published by
   8 .\" the Free Software Foundation, either version 2 of the License, or
   9 .\" (at your option) any later version.
  10 .\"
  11 .\" Pwmd is distributed in the hope that it will be useful,
  12 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 .\" GNU General Public License for more details.
  15 .\"
  16 .\" You should have received a copy of the GNU General Public License
  17 .\" along with pwmd.  If not, see <http://www.gnu.org/licenses/>.
  18 .de URL
  19 \\$2 \(laURL: \\$1 \(ra\\$3
  20 ..
  21 .if \n[.g] .mso www.tmac
  22 .TH PWMD-DUMP 1 "27 Jul 2016" "@VERSION@" "Password Manager Daemon"
  23 .SH NAME
  24
  25 pwmd-dump \- dump raw XML from a pwmd 3.0.x data file
  26 .SH SYNOPSIS
  27 .B pwmd-dump
  28 [options] <infile> <outfile>
  29
  30 .SH DESCRIPTION
  31 .B pwmd-dump
  32 reads a
  33 .BR pwmd (1)
  34 version 3.0.x data file and dumps the raw unencrypted XML to the specified
  35 output file while stripping the literal element character and non-reserved
  36 attributes and child nodes of an element with a
  37 .B target
  38 attribute. See option
  39 .B --no-convert.
  40 .P
  41 If
  42 .B <outfile>
  43 is
  44 .B "-"
  45 then the output will be written to standard output. Otherwise,
  46 .B <outfile>
  47 must not already exist.
  48 .P
  49 It is recommended to securely delete the resulting XML file after importing to
  50 prevent recovering. There are a few tools that can do this:
  51 .BR wipe (1)
  52 ,
  53 .BR srm (1)
  54 ,
  55 .BR shred (1)
  56 and others.
  57
  58 .SH OPTIONS
  59 .TP
  60 .I "\--no-convert, -n"
  61 Before dumping the XML,
  62 .B pwmd-dump
  63 will strip any leading literal element character '!' from
  64 each element in the element path of a "target" attribute and remove all
  65 non-reserved attributes and all child nodes of the element containing
  66 the "target" attribute. Since version 3.1 of
  67 .B pwmd
  68 there are no such literal elements. All targets are followed just as a
  69 symbolic link on a filesystem. This option prevents converting and will dump
  70 the XML unmodified.
  71
  72 .TP
  73 .I "\--force"
  74 Do not abort conversion and force removal of content and children of an
  75 element with a "target" attribute.
  76
  77 .TP
  78 .I "\--xml"
  79 The file to read is a raw unencrypted
  80 .B pwmd
  81 XML document.
  82
  83 .TP
  84 .I "\--keyfile <filename>"
  85 Obtain the passphrase to use to decrypt the data file from the specified
  86 filename.
  87
  88 .TP
  89 .I "\--version"
  90 Show version information.
  91
  92 .TP
  93 .I "\--help"
  94 Show help text.
  95
  96 .SH AUTHOR
  97 Ben Kibbey <bjk@luxsci.net>
  98 .br
  99 .URL "http://pwmd.sourceforge.net/" "Pwmd Homepage" .
 100
 101 .SH "SEE ALSO"
 102 .BR pwmd (1)
 103
 104 And the pwmd texinfo manual for protocol commands and their syntax.