changeset 16812:366a13bd71d5

doc: Add base64_encode()/base64_decode() to documentation. * doc/interpreter/octave.texi: Add menu item for Base64. * doc/interpreter/system.txi: Add menu item for Base64. Add @DOCSTRING macros for base64_encode/base64_decode.
author Rik <rik@octave.org>
date Sat, 22 Jun 2013 13:58:30 -0700
parents 81344ade678f
children 81e041f5633a
files doc/interpreter/octave.texi doc/interpreter/system.txi
diffstat 2 files changed, 13 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/octave.texi
+++ b/doc/interpreter/octave.texi
@@ -763,6 +763,7 @@
 
 * FTP Objects::
 * URL Manipulation::
+* Base64 and Binary Data Transmission::
 
 Java Interface
 
--- a/doc/interpreter/system.txi
+++ b/doc/interpreter/system.txi
@@ -259,6 +259,7 @@
 @menu
 * FTP Objects::
 * URL Manipulation::
+* Base64 and Binary Data Transmission::
 @end menu
 
 @DOCSTRING(gethostname)
@@ -301,6 +302,17 @@
 
 @DOCSTRING(urlwrite)
 
+@node Base64 and Binary Data Transmission
+@subsection Base64 and Binary Data Transmission
+
+Some transmission channels can not accept binary data.  It is customary to
+encode binary data in Base64 for transmission and to decode the data upon
+reception.
+
+@DOCSTRING(base64_encode)
+
+@DOCSTRING(base64_decode)
+
 @node Controlling Subprocesses
 @section Controlling Subprocesses