.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "SVN::Dump 3pm" .TH SVN::Dump 3pm "2022-10-14" "perl v5.34.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" SVN::Dump \- A Perl interface to Subversion dumps .SH "VERSION" .IX Header "VERSION" version 0.08 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 4 \& #!/usr/bin/perl \& use strict; \& use warnings; \& use SVN::Dump; \& \& my $file = shift; \& my $dump = SVN::Dump\->new( { file => $file } ); \& \& # compute some stats \& my %type; \& my %kind; \& while ( my $record = $dump\->next_record() ) { \& $type{ $record\->type() }++; \& $kind{ $record\->get_header(\*(AqNode\-action\*(Aq) }++ \& if $record\->type() eq \*(Aqnode\*(Aq; \& } \& \& # print the results \& print "Statistics for dump $file:\en", \& " version: ", $dump\->version(), "\en", \& " uuid: ", $dump\->uuid(), "\en", \& " revisions: ", $type{revision}, "\en", \& " nodes: ", $type{node}, "\en"; \& print map { sprintf " \- %\-7s: %d\en", $_, $kind{$_} } sort keys %kind; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" An SVN::Dump object represents a Subversion dump. .PP This module follow the semantics used in the reference document (the file \fInotes/fs_dumprestore.txt\fR in the Subversion source tree): .IP "\(bu" 4 A dump is a collection of records (SVN::Dump::Record objects). .IP "\(bu" 4 A record is composed of a set of headers (a SVN::Dump::Headers object), a set of properties (a SVN::Dump::Property object) and an optional bloc of text (a SVN::Dump::Text object). .IP "\(bu" 4 Some special records (\f(CW\*(C`delete\*(C'\fR records with a \f(CW\*(C`Node\-kind\*(C'\fR header) recursively contain included records. .PP Each class has a \f(CW\*(C`as_string()\*(C'\fR method that prints its content in the dump format. .PP The most basic thing you can do with SVN::Dump is simply copy a dump: .PP .Vb 1 \& use SVN::Dump; \& \& my $dump = SVN::Dump\->new( { file => \*(Aqmydump.svn\*(Aq } ); \& $dump\->next_record; # read the format header \& $dump\->next_record; # read the uuid header \& print $dump\->as_string(); # only print the dump header \& \& while( $rec = $dump\->next_record() ) { \& print $rec\->as_string(); \& } .Ve .PP After the operation, the resulting dump should be identical to the original dump. .SH "METHODS" .IX Header "METHODS" SVN::Dump provides the following methods: .IP "new( \e%args )" 4 .IX Item "new( %args )" Return a new SVN::Dump object. .Sp The argument list is a hash reference. .Sp If the SVN::Dump object will read information from a file, the arguments \f(CW\*(C`file\*(C'\fR is used (as usal, \f(CW\*(C`\-\*(C'\fR means \f(CW\*(C`STDIN\*(C'\fR); if the dump is read from a filehandle, \f(CW\*(C`fh\*(C'\fR is used. .Sp Extra options will be passed to the SVN::Dump::Reader object that is created. .Sp If the SVN::Dump isn't used to read information, the parameters \&\f(CW\*(C`version\*(C'\fR and \f(CW\*(C`uuid\*(C'\fR can be used to initialise the values of the \f(CW\*(C`SVN\-fs\-dump\-format\-version\*(C'\fR and \f(CW\*(C`UUID\*(C'\fR headers. .IP "\fBnext_record()\fR" 4 .IX Item "next_record()" Return the next record read from the dump. This is a SVN::Dump::Record object. .IP "\fBversion()\fR" 4 .IX Item "version()" .PD 0 .IP "\fBformat()\fR" 4 .IX Item "format()" .PD Return the dump format version, if the version record has already been read, or if it was given in the constructor. .IP "\fBuuid()\fR" 4 .IX Item "uuid()" Return the dump \s-1UUID,\s0 if there is an \s-1UUID\s0 record and it has been read, or if it was given in the constructor. .IP "\fBas_string()\fR" 4 .IX Item "as_string()" Return a string representation of the dump specific blocks (the \f(CW\*(C`format\*(C'\fR and \f(CW\*(C`uuid\*(C'\fR blocks only). .SH "SEE ALSO" .IX Header "SEE ALSO" SVN::Dump::Reader, SVN::Dump::Record. .PP The reference document for Subversion dumpfiles is at: .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2006\-2020 Philippe Bruhat (BooK), All Rights Reserved. .SH "LICENSE" .IX Header "LICENSE" This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.