tools/dsync-0.0/doc/dsync-flist.1.yo

   1 mailto(jgg@debian.org)
   2 manpage(dsync-flist)(1)(17 Jan 1999)(dsync)()
   3 manpagename(dsync)(DSync Mirroring utility -- command-line file list manipulator)
   4
   5 manpagesynopsis()
   6   dsync-flist [options] [command] [file]
   7
   8 manpagedescription()
   9
  10 dsync-flist is the command line tool for generating and manipulating the
  11 dsync file list. It can check a previosly generated list against the local
  12 tree and provide a report on its findings. The dsync file list is an
  13 optimized binary file suitable for transmission over the internet.
  14
  15 em(command) is one of:
  16 itemize(
  17   it() generate em(filelist)
  18   it() help
  19   it() dump em(filelist)
  20   it() md5sums em(filelist)
  21   it() md5cache em(filelist)
  22   it() lookup em(filelist dir file)
  23   it() link-dups em(filelist)
  24   it() verify em(filelist)
  25 )
  26
  27 Unless the -h, or --help option is given one of the above commands
  28 must be present.
  29
  30 startdit()
  31 dit(bf(generate))
  32 bf(generate) creates a file list. It takes as an argument the location to
  33 write the file list to and then procceeds to recursively scan . to produce
  34 the list. If md5 generation is enabled bf(generate) will use the previous
  35 list as a cache for md5 checksums, only building new checksums if the file
  36 size or timestamp has changed.
  37
  38 dit(bf(help))
  39 Displays the help text
  40
  41 dit(bf(dump))
  42 bf(dump) shows the contents of the given file list in a short form. The first
  43 word is a type field and the remaing fields represent stored information.
  44 The possible types are F - File, D - Directory, DM - Directory Marker, DS -
  45 Directory Start, H - Header, S - Device Special, L - Symlink, T - Trailer.
  46 After this the actual fields are displayed. Mod - Modification time in
  47 seconds since the unix epoch, N - Entitiy Name, MD5 - MD5 hash, Sz - Size
  48 in bytes, T - Link Target, U/G - User/Group internal ID, Sig - Header
  49 signature, Maj - Header major number, Min - Header minor number, Epoch -
  50 Internal Epoch offset, Count - Flag counter.
  51
  52 dit(bf(md5sums))
  53 bf(md5sums) takes the contents of the file list and displays the stored md5
  54 of every file and then the file name. This output can then be given to
  55 bf(md5sum -c) (GNU) to verify the checksums. Combined with the caching
  56 action of the file list generator this can make md5 indexes of large archives
  57 practical.
  58
  59 dit(bf(md5cache))
  60 Like bf(md5sums), bf(md5cache) displays the md5sums of the files given
  61 on stdin. It will use cached MD5 information if possible otherwise it will
  62 compute the MD5 and return that. It is necessary to run this command from the
  63 same directory the file list was generated in and to give filenames relative
  64 to that directory. Otherwise the caching mechanism will not work.
  65
  66 dit(bf(lookup))
  67 bf(lookup) searches for a single entity in the list. You must specify the
  68 directory, ending in / and then the entity in that directory. The output is
  69 the same as bf(dump)
  70
  71 dit(bf(link-dups))
  72 bf(link-dups) checks the entire file list for files that have duplicate
  73 contents and hard links them. It does this by examining the MD5 information
  74 from the file list and then converting the duplicated files into a hard link.
  75 The file choosen to be the target of all other links is the first file
  76 listed in the file list. The timestamp of the new link is set to be the
  77 largest timestamp of all the other links and the permissions and ownership
  78 remain as the first link. Output is two lines per combination, the first
  79 indicting the source file and the second the file that will be erased and
  80 hardlinked, a souce file may occure multiple times if there are many
  81 duplicated copies.
  82
  83 dit(bf(verify))
  84 bf(verify) checks the given file list against . and reports and deviations.
  85
  86 enddit()
  87
  88 manpageoptions()
  89 All command line options may be set using the configuration file, the
  90 descriptions indicate the configuration option to set. For boolean
  91 options you can override the config file by using something like bf(-f-),
  92 bf(--no-f), bf(-f=no) or several other variations.
  93
  94 startdit()
  95 dit(bf(-h, --help))
  96 Show the help text
  97
  98 dit(bf(-q, --quiet, --silent))
  99 Quiet; produces output suitable for logging, omitting progress indicators.
 100 More qs will produce more quite up to a maximum of 2. You can also use
 101 bf(-q=#) to set the quiet level, overriding the configuration file.
 102 See bf(quiet)
 103
 104 dit(bf(-i, --include))
 105 dit(bf(-e, --exclude))
 106 Add a pattern to the ordered include list. See bf(FileList::Filter).
 107
 108 dit(bf(-n, --no-act))
 109 Suppress action; No changes will be made to the local file system. This
 110 applies to bf(generate) and bf(verify).
 111
 112 dit(bf(--delete))
 113 Allow files to be deleted; This allows files to be erased, it effects
 114 bf(generate) and bf(verify). See bf(delete).
 115
 116 dit(bf(--pi, --perfer-include))
 117 dit(bf(--pe, --perfer-exclude))
 118 Add a pattern to the ordered prefer include list. See
 119 bf(FileList::Prefer-Filter).
 120
 121 dit(bf(--ci, --clean-include))
 122 dit(bf(--ce, --clean-exclude))
 123 Add a pattern to the ordered clean include list. Things excluded by this
 124 filter will be erased. See bf(FileList::Clean-Filter).
 125
 126 dit(bf(--md5))
 127 Generate md5 hashes into the list. See bf(FileList::MD5-Hashes).
 128
 129 dit(bf(--perm))
 130 Generate file permissions into the list. See bf(FileList::Permissions).
 131
 132 dit(bf(--owner))
 133 Generate file ownership into the list [unsupported]. See
 134 bf(FileList::Ownership).
 135
 136 dit(bf(-c, --config-file))
 137 Configuration File; Specify a configuration file to use. bf(apt-get) will
 138 read the default configuration file and then this configuration file. See
 139 bf(apt.conf(5)) for syntax information.
 140
 141 dit(bf(-o, --option))
 142 Set a Configuration Option; This will set an arbitary configuration option.
 143 The syntax is
 144 verb(-o Foo::Bar=bar)
 145
 146 enddit()
 147
 148 manpageseealso()
 149 dsync.conf(5)
 150
 151 manpagediagnostics()
 152 dsync-flist returns zero on normal operation, decimal 100 on error.
 153
 154 manpagebugs()
 155 See https://bugs.debian.org/dsync.  If you wish to report a
 156 bug in bf(apt-get), please see bf(/usr/doc/debian/bug-reporting.txt)
 157 or the bf(bug(1)) command.
 158
 159 manpageauthor()
 160 dsync was written by Jason Gunthorpe <jgg@debian.org>.