sbin/jscan/jscan.8

   1 .\" Copyright (c) 2004,2005 The DragonFly Project.  All rights reserved.
   2 .\"
   3 .\" This code is derived from software contributed to The DragonFly Project
   4 .\" by Matthew Dillon <dillon@backplane.com>
   5 .\"
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in
  15 .\"    the documentation and/or other materials provided with the
  16 .\"    distribution.
  17 .\" 3. Neither the name of The DragonFly Project nor the names of its
  18 .\"    contributors may be used to endorse or promote products derived
  19 .\"    from this software without specific, prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\" $DragonFly: src/sbin/jscan/jscan.8,v 1.2 2005/07/05 00:26:03 dillon Exp $
  35 .\"
  36 .Dd March 6, 2005
  37 .Dt JSCAN 8
  38 .Os
  39 .Sh NAME
  40 .Nm jscan
  41 .Nd journal file processing program
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Fl rd
  45 .Op Ar journal_files
  46 .Pp
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility scans journal files for the purposes of debugging dumps, restoration,
  51 undo, mirroring, and other journaling features.
  52 .Bl -tag -width indent
  53 .It Fl d
  54 dumps the contents of the journaling file in a human readable format.
  55 .It Fl r
  56 will cause the journal be scanned backwards.  Transactions will be dumped in
  57 reverse order.  However, note that due to parallelism the order will not be
  58 the exact reverse of a forward scan, since large transactions are not dumped
  59 until all stream segments have been collected for them.
  60 .El
  61 .Pp
  62 .Sh FILES
  63 .Sh SEE ALSO
  64 .Xr mountctl 8
  65 .Sh BUGS
  66 .Sh CAVEATS
  67 This utility is currently under construction and not all features have been
  68 implemented yet.  In fact, most have not.
  69 .Sh HISTORY
  70 The
  71 .Nm
  72 utility first appeared in DragonFly .