diff options
Diffstat (limited to 'python/macholib/doc/MachO.rst')
-rw-r--r-- | python/macholib/doc/MachO.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/python/macholib/doc/MachO.rst b/python/macholib/doc/MachO.rst new file mode 100644 index 000000000..204e04087 --- /dev/null +++ b/python/macholib/doc/MachO.rst @@ -0,0 +1,19 @@ +:mod:`macholib.MachO` --- Utilities for reading and writing Mach-O headers +========================================================================== + +.. module:: macholib.MachO + :synopsis: Utilities for reading and writing Mach-O headers + +This module defines a class :class:`Macho`, which enables reading +and writing the Mach-O header of an executable file or dynamic +library on MacOS X. + +.. class:: MachO(filename) + + Creates a MachO object by reading the Mach-O headers from + *filename*. + + The *filename* should refer to an existing file in Mach-O + format, and can refer to fat (universal) binaries. + +.. note:: more information will be added later |