[Debootloaders-devel] r154 - in trunk/rsrce: . debian

[Jeremie Koenig]

Author: jkoenig-guest
Date: 2006-07-26 01:57:17 +0000 (Wed, 26 Jul 2006)
New Revision: 154

Modified:
   trunk/rsrce/TODO
   trunk/rsrce/debian/changelog
   trunk/rsrce/rsrce.1
Log:
Improve the manual page


Modified: trunk/rsrce/TODO
===================================================================
--- trunk/rsrce/TODO	2006-07-26 01:46:25 UTC (rev 153)
+++ trunk/rsrce/TODO	2006-07-26 01:57:17 UTC (rev 154)
@@ -1,2 +1,4 @@
+- rsrce.1: document the syntax of attr-spec, tell about the default filename
+  for read and write (but the code should be clarified first)
 - add commands for changing the resource fork's reserved space and attributes
 - fix 'rename' to allow both removing the name and setting an empty one

Modified: trunk/rsrce/debian/changelog
===================================================================
--- trunk/rsrce/debian/changelog	2006-07-26 01:46:25 UTC (rev 153)
+++ trunk/rsrce/debian/changelog	2006-07-26 01:57:17 UTC (rev 154)
@@ -1,11 +1,11 @@
 rsrce (0.2.2) unstable; urgency=low
 
-  * Fix rsrce manpage section.
+  * Improve the manual page. 
   * Add some command line options to allow for '#!/usr/bin/rsrce -ef' scripts.
   * A bug prevented file to be read on big-endian architectures; fix provided
     by Piotr Krysiuk. (closes: #379878)
 
- -- Jeremie Koenig <sprite at sprite.fr.eu.org>  Wed, 26 Jul 2006 03:45:08 +0200
+ -- Jeremie Koenig <sprite at sprite.fr.eu.org>  Wed, 26 Jul 2006 03:54:33 +0200
 
 rsrce (0.2.1) unstable; urgency=low
 

Modified: trunk/rsrce/rsrce.1
===================================================================
--- trunk/rsrce/rsrce.1	2006-07-26 01:46:25 UTC (rev 153)
+++ trunk/rsrce/rsrce.1	2006-07-26 01:57:17 UTC (rev 154)
@@ -17,6 +17,11 @@
 Rsrce is a command driven Macintosh
 resource fork editor for Unix-like
 operating systems.
+It works with raw resource forks
+stored in Unix files,
+such as the .rsrc files produced by the
+.B macutil
+package.
 
 Rsrce doesn't allow you to edit the
 resource data directly.
@@ -62,12 +67,13 @@
 
 .SH USAGE
 
-Rsrce reads commands
-from its standard input.
-Lines which contain only whitespace
-and lines which begin with
+Rsrce reads commands from the standard input.
+Unquoted whitespace is ignored,
+except for the purpose of separating arguments.
+Empty lines are ignored, and a
 .B #
-are ignored.
+at a position where an argument would have started
+indicates a comment which extends to the end of the line.
 Text within single quotes is used as-is.
 An unquoted backslash can be used
 the way it works in C strings,
@@ -77,24 +83,45 @@
 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.
+If the given type has less than 4 letters,
+spaces are added to complete it.
 
 The following commands are available:
 
 .TP
-.BI "read " file
+.BR "read " [\fIfile\fR]
 read the resources from
 .I file
 
 .TP
-.BI "write " file
-write the resources to file
+.BR "write " [\fIfile\fR]
+write the resources to
+.I file
 
 .TP
+.BI "create " resource
+create a new, empty resource with the given type and id
+
+.TP
+.BI "delete " resource
+remove the specified
+.I resource
+
+.TP
+.BI "rename " resource " " new-name
+change the name associated with
+.IR resource " to " new-name
+
+.TP
+.BI "chattr " resource " " attr-spec
+change the attributes of
+.I resource
+according to
+.I attr-spec
+
+.TP
 .B ls
-list resources (type, id, attributes, data lenght, name)
+list each resource's type, id, attributes, data lenght, and name
 
 .TP
 .BI "hexdump " resource
@@ -103,14 +130,18 @@
 data
 
 .TP
-.BI "import|export " "resource file"
+.BI import \fR| "export " resource " " file " \fR[" ext \fR]
 import/export
 .IR resource 's
 data from/to
-.I file
+.I file.
+The conversion which is performed
+depends on the extension of the given filename.
+This extenstion may be overriden by providing the
+.IR ext argument.
 
 .TP
-.BI "edit " resource
+.BI "edit " resource \fR[ ext \fR]
 invoke an external editor to change
 .IR resource 's
 data
@@ -125,7 +156,27 @@
 (without saving, use write before exit
 if you wish to save your changes)
 
+.SH CONVERSION OF RESOURCE DATA
 
+When
+.B rsrce
+imports or exports resource data,
+a conversion can be performed depending on the resource type
+and the extension of the provided filename.
+
+The following extensions are known to
+.BR rsrce :
+.TP
+.B bin
+causes no conversion,
+the raw resource data is used
+regardless of the resource type;
+.TP
+.B txt
+causes the resource data to be converted to plain text.
+This is possible for
+.BR  STR ", " STR# and CMDL resources.
+
 .SH BUGS
 
 Rsrce has only been originally created
@@ -152,5 +203,6 @@
 
 .SH SEE ALSO
 
-.BR hfsutils (1)
+.BR hfsutils (1),
+.BR macutil (1)