[Debootloaders-devel] r61 - trunk/rsrce

[Aurélien GÉRÔME]

Author: ag-guest
Date: 2006-07-11 01:04:11 +0000 (Tue, 11 Jul 2006)
New Revision: 61

Added:
   trunk/rsrce/rsrce.1
Log:
Add a manpage.


Added: trunk/rsrce/rsrce.1
===================================================================
--- trunk/rsrce/rsrce.1	2006-07-11 01:03:16 UTC (rev 60)
+++ trunk/rsrce/rsrce.1	2006-07-11 01:04:11 UTC (rev 61)
@@ -0,0 +1,111 @@
+.TH RSRCE "8" "2004-03-26" "Debian Project" "Debian GNU/Linux"
+
+.SH NAME
+
+rsrce \- editor for raw MacOS resource forks
+
+.SH SYNOPSIS
+
+.B rsrce
+.RI [ filename ]
+
+.SH DESCRIPTION
+
+Rsrce is command driven Macintosh
+resource fork editor for Unix-like
+operating systems.
+
+Rsrce doesn't allow you to edit the
+resource data directly.
+It only knows to import/export them
+from/to files, performing conversion for
+the few resource types it knows.
+
+.SH USAGE
+
+If a
+.I filename
+is given on the command-line,
+the resource are read from the file
+when rsrce is launched.
+
+Resources are referred to by specifing
+their type and id, separated by a colon.
+I mean, something like "STR#:128".
+If the type field contains less than 4
+letters, spaces are added to complete
+it.
+
+The following commands are available:
+
+.TP
+.BI "read " file
+read the resources from
+.I file
+
+.TP
+.BI "write " file
+write the resources to file
+
+.TP
+.B ls
+list resources (type, id, attributes, data lenght, name)
+
+.TP
+.BI "hexdump " resource
+show an hexdump of
+.IR resource 's
+data
+
+.TP
+.BI "import|export " "resource file"
+import/export
+.IR resource 's
+data from/to
+.I file
+
+.TP
+.BI "edit " resource
+invoke an external editor to change
+.IR resource 's
+data
+
+.TP
+.B help
+list available commands
+
+.TP
+.B exit
+terminate rsrce
+(without saving, use write before exit
+if you wish to save your changes)
+
+
+.SH BUGS
+
+Rsrce has only been originally created
+to change the configuration of the
+miBoot Linux bootloader for OldWorld
+PowerMac computers.
+Since I do not use MacOS, I haven't
+tested any other usage of this program.
+You should therefore be very careful
+when using it, as it could very well
+produce unusable output.
+
+Another consequence of this is wildly
+missing functionnality.
+I'm not going to work on it, since I
+couldn't test anything in a real
+situation.
+Patches and/or usage reports would be
+very welcome.
+
+.SH AUTHOR
+
+Jeremie Koenig <sprite at sprite.fr.eu.org>
+
+.SH SEE ALSO
+
+.BR hfsutils (1)
+