1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
<?xml version='1.0' encoding="utf-8"?>
<!-- $Revision: 297078 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.xdiff-file-bdiff" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>xdiff_file_bdiff</refname>
<refpurpose>Make binary diff of two files</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>xdiff_file_bdiff</methodname>
<methodparam><type>string</type><parameter>old_file</parameter></methodparam>
<methodparam><type>string</type><parameter>new_file</parameter></methodparam>
<methodparam><type>string</type><parameter>dest</parameter></methodparam>
</methodsynopsis>
<para>
Makes a binary diff of two files and stores the result in a patch file.
This function works with both text and binary files. Resulting patch
file can be later applied using <function>xdiff_file_bpatch</function>/<function>xdiff_string_bpatch</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>old_file</parameter></term>
<listitem>
<para>
Path to the first file. This file acts as "old" file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>new_file</parameter></term>
<listitem>
<para>
Path to the second file. This file acts as "new" file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem>
<para>
Path of the resulting patch file. Resulting file contains differences
between "old" and "new" files. It is in binary format and is human-unreadable.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>xdiff_file_bdiff</function> example</title>
<para>
The following code makes binary diff of two archives.
</para>
<programlisting role="php">
<![CDATA[
<?php
$old_version = 'my_script_1.0.tgz';
$new_version = 'my_script_1.1.tgz';
xdiff_file_bdiff($old_version, $new_version, 'my_script.bdiff');
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
Both files will be loaded into memory so ensure that your memory_limit is
set high enough.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>xdiff_file_bpatch</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
