summaryrefslogtreecommitdiff
path: root/perl/perl-Convert-UU/README
diff options
context:
space:
mode:
Diffstat (limited to 'perl/perl-Convert-UU/README')
-rw-r--r--perl/perl-Convert-UU/README22
1 files changed, 22 insertions, 0 deletions
diff --git a/perl/perl-Convert-UU/README b/perl/perl-Convert-UU/README
new file mode 100644
index 0000000000..e7ab92b7ae
--- /dev/null
+++ b/perl/perl-Convert-UU/README
@@ -0,0 +1,22 @@
+Convert::UU -- Perl module for uuencode and uudecode
+
+- uuencode
+
+uuencode() takes as the first argument a string that is to
+be uuencoded. Note, that it is the string that is encoded,
+not a filename. Alternatively a filehandle may be passed
+that must be opened for reading. It returns the uuencoded
+string including begin and end. Second and third argument
+are optional and specify filename and mode. If unspecified
+these default to "uuencode.uu" and 644.
+
+- uudecode
+
+uudecode() takes a string as argument which will be uudecoded.
+If the argument is a filehandle this handle will be read
+instead. If it is a reference to an ARRAY, the elements are
+treated like lines that form a string. Leading and trailing
+garbage will be ignored. The function returns the uudecoded
+string for the first begin/end pair. In array context it
+returns an array whose first element is the uudecoded string,
+the second is the filename and the third is the mode.