{ "content": [ { "type": "text", "text": "# uuencode (man)\n\n## NAME\n\nuuencode - encode a file into email friendly text\n\n## SYNOPSIS\n\nuuencode [-flags] [-flag [value]] [--option-name[[=| ]value]] [] \n\n## DESCRIPTION\n\nuuencode is used to create an ASCII representation of a file that can be sent over channels\nthat may otherwise corrupt the data. Specifically, email cannot handle binary data and will\noften even insert a character when the six character sequence \"0rom \" is seen.\n\n## TLDR\n\n> Encode binary files into ASCII for transport via mediums that only support simple ASCII encoding.\n\n- Encode a file and print the result to `stdout`:\n `uuencode {{path/to/input_file}} {{output_file_name_after_decoding}}`\n- Encode a file and write the result to a file:\n `uuencode -o {{path/to/output_file}} {{path/to/input_file}} {{output_file_name_after_decoding}}`\n- Encode a file using Base64 instead of the default uuencode encoding and write the result to a file:\n `uuencode {{-m|--base64}} -o {{path/to/output_file}} {{path/to/input_file}} {{output_file_name_after_decoding}}`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (6 subsections)\n- **STANDARDS**\n- **FILES**\n- **EXIT STATUS**\n- **HISTORY**\n- **AUTHORS**\n- **COPYRIGHT**\n- **BUGS**\n- **NOTES**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "uuencode", "section": "", "mode": "man", "summary": "uuencode - encode a file into email friendly text", "synopsis": "uuencode [-flags] [-flag [value]] [--option-name[[=| ]value]] [] ", "tldr_summary": "Encode binary files into ASCII for transport via mediums that only support simple ASCII encoding.", "tldr_examples": [ { "description": "Encode a file and print the result to `stdout`", "command": "uuencode {{path/to/input_file}} {{output_file_name_after_decoding}}" }, { "description": "Encode a file and write the result to a file", "command": "uuencode -o {{path/to/output_file}} {{path/to/input_file}} {{output_file_name_after_decoding}}" }, { "description": "Encode a file using Base64 instead of the default uuencode encoding and write the result to a file", "command": "uuencode {{-m|--base64}} -o {{path/to/output_file}} {{path/to/input_file}} {{output_file_name_after_decoding}}" } ], "tldr_source": "official", "flags": [ { "flag": "-m", "long": "--base64", "arg": null, "description": "By default, uuencode will encode using the traditional conversion. It is slower and less compact than base64. The encoded form of the file is expanded by 37% for UU encoding and by 35% for base64 encoding (3 bytes become 4 plus control information)." }, { "flag": "-e", "long": "--encode-file-name", "arg": null, "description": "Since output file names may contain characters that are not handled well by various transmis‐ sion modes, you may specify that the output-name be base64 encoded as well. (Traditional uuencoding of the file name is not supported.)" }, { "flag": "-h", "long": "--help", "arg": null, "description": "-!, --more-help Pass the extended usage information through a pager." }, { "flag": "-R", "long": "--save-opts", "arg": null, "description": "last configuration file listed in the OPTION PRESETS section, below. The command will exit after updating the config file." }, { "flag": "-r", "long": "--no-load-opts", "arg": null, "description": "form will disable the loading of earlier config/rc/ini files. --no-load-opts is handled early, out of order." }, { "flag": "-v", "long": "--version", "arg": null, "description": "`v', a simple version. The `c' mode will print copyright information and `n' will print the full copyright notice. OPTION PRESETS Any option that is not marked as not presettable may be preset by loading values from configuration (\"RC\" or \".INI\") file(s). The file \"$HOME/.sharrc\" will be used, if present." } ], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 3, "subsections": [] }, { "name": "DESCRIPTION", "lines": 12, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "-m --base64", "lines": 4, "flag": "-m", "long": "--base64" }, { "name": "-e --encode-file-name", "lines": 4, "flag": "-e", "long": "--encode-file-name" }, { "name": "-h --help", "lines": 2, "flag": "-h", "long": "--help" }, { "name": "-R --save-opts", "lines": 3, "flag": "-R", "long": "--save-opts" }, { "name": "-r _ --load-opts --no-load-opts", "lines": 3, "flag": "-r", "long": "--no-load-opts" }, { "name": "-v --version", "lines": 8, "flag": "-v", "long": "--version" } ] }, { "name": "STANDARDS", "lines": 2, "subsections": [] }, { "name": "FILES", "lines": 2, "subsections": [] }, { "name": "EXIT STATUS", "lines": 14, "subsections": [] }, { "name": "HISTORY", "lines": 2, "subsections": [] }, { "name": "AUTHORS", "lines": 2, "subsections": [] }, { "name": "COPYRIGHT", "lines": 3, "subsections": [] }, { "name": "BUGS", "lines": 5, "subsections": [] }, { "name": "NOTES", "lines": 3, "subsections": [] } ], "sections": { "NAME": { "content": "uuencode - encode a file into email friendly text\n", "subsections": [] }, "SYNOPSIS": { "content": "uuencode [-flags] [-flag [value]] [--option-name[[=| ]value]] [] \n\n", "subsections": [] }, "DESCRIPTION": { "content": "uuencode is used to create an ASCII representation of a file that can be sent over channels\nthat may otherwise corrupt the data. Specifically, email cannot handle binary data and will\noften even insert a character when the six character sequence \"0rom \" is seen.\n\nuuencode will read in-file if provided and otherwise read data from standard in and write the\nencoded form to standard out. The output will begin with a header line for use by uudecode\ngiving it the resulting suggested file output-name and access mode. If the output-name is\nspecifically /dev/stdout, then uudecode will emit the decoded file to standard out.\n\nNote: uuencode uses buffered input and assumes that it is not hand typed from a tty. The\nconsequence is that at a tty, you may need to hit Ctl-D several times to terminate input.\n", "subsections": [] }, "OPTIONS": { "content": "", "subsections": [ { "name": "-m --base64", "content": "By default, uuencode will encode using the traditional conversion. It is slower and less\ncompact than base64. The encoded form of the file is expanded by 37% for UU encoding and by\n35% for base64 encoding (3 bytes become 4 plus control information).\n", "flag": "-m", "long": "--base64" }, { "name": "-e --encode-file-name", "content": "Since output file names may contain characters that are not handled well by various transmis‐\nsion modes, you may specify that the output-name be base64 encoded as well. (Traditional\nuuencoding of the file name is not supported.)\n", "flag": "-e", "long": "--encode-file-name" }, { "name": "-h --help", "content": "-!, --more-help Pass the extended usage information through a pager.\n", "flag": "-h", "long": "--help" }, { "name": "-R --save-opts", "content": "last configuration file listed in the OPTION PRESETS section, below. The command will exit\nafter updating the config file.\n", "flag": "-R", "long": "--save-opts" }, { "name": "-r _ --load-opts --no-load-opts", "content": "form will disable the loading of earlier config/rc/ini files. --no-load-opts is handled\nearly, out of order.\n", "flag": "-r", "long": "--no-load-opts" }, { "name": "-v --version", "content": "`v', a simple version. The `c' mode will print copyright information and `n' will print the\nfull copyright notice.\n\nOPTION PRESETS\nAny option that is not marked as not presettable may be preset by loading values from\nconfiguration (\"RC\" or \".INI\") file(s). The file \"$HOME/.sharrc\" will be used, if\npresent.\n", "flag": "-v", "long": "--version" } ] }, "STANDARDS": { "content": "This implementation is compliant with P1003.2b/D11.\n", "subsections": [] }, "FILES": { "content": "See OPTION PRESETS for configuration files.\n", "subsections": [] }, "EXIT STATUS": { "content": "One of the following exit values will be returned:\n\n0 (EXITSUCCESS) Successful program execution.\n\n1 (EXITFAILURE) The operation failed or the command syntax was not valid.\n\n66 (EXNOINPUT) A specified configuration file could not be loaded.\n\n70 (EXSOFTWARE) libopts had an internal operational error. Please report it to autogen-\nusers@lists.sourceforge.net. Thank you.\n\nSEE ALSO\nuudecode(1), uuencode(5)\n", "subsections": [] }, "HISTORY": { "content": "The uuencode command first appeared in BSD 4.0.\n", "subsections": [] }, "AUTHORS": { "content": "Free Software Foundation, Inc.\n", "subsections": [] }, "COPYRIGHT": { "content": "Copyright (C) 1994-2015 Free Software Foundation, Inc. all rights reserved. This program is\nreleased under the terms of the GNU General Public License, version 3 or later.\n", "subsections": [] }, "BUGS": { "content": "Please put sharutils in the subject line for emailed bug reports. It helps to spot the mes‐\nsage.\n\nPlease send bug reports to: bug-gnu-utils@gnu.org\n", "subsections": [] }, "NOTES": { "content": "This manual page was AutoGen-erated from the uuencode option definitions.\n\nGNU sharutils (4.15.2) 30 May 2015 uuencode(1)", "subsections": [] } } } }