mirror/freebsd
1
0
Fork 0
mirror of https://git.FreeBSD.org/src.git synced 2024-12-23 11:18:54 +00:00
Code Issues Releases Activity
3d07cc29cf
freebsd/usr.bin/file2c/file2c.1

76 lines
2.4 KiB
Groff
Raw Normal View History

This is a small little program used to execute a bad practice a clean way :-) It will read a file on stdin and write it as decimal integers on stdout, this is useful for embedding files in c-sources. There are a few places where this is needed, and this is a better way than the current practice of hand-editing the sources. The command: date | file2c 'const char date[] = {' ',0};' will produce: const char date[] = { 83,97,116,32,74,97,110,32,50,56,32,49,54,58,52,55,58,51,51,32,80,83,84, 32,49,57,57,53,10 ,0}; The manual page is 2 lines longer than the source :-)
1995-01-29 00:49:57 +00:00
.\"----------------------------------------------------------------------------
.\" "THE BEER-WARE LICENSE" (Revision 42):
Spell "FreeBSD" with "F" and "BSD" in uppercase.
2001-08-13 16:33:00 +00:00
.\" <phk@FreeBSD.org> wrote this file. As long as you retain this notice, you
This is a small little program used to execute a bad practice a clean way :-) It will read a file on stdin and write it as decimal integers on stdout, this is useful for embedding files in c-sources. There are a few places where this is needed, and this is a better way than the current practice of hand-editing the sources. The command: date | file2c 'const char date[] = {' ',0};' will produce: const char date[] = { 83,97,116,32,74,97,110,32,50,56,32,49,54,58,52,55,58,51,51,32,80,83,84, 32,49,57,57,53,10 ,0}; The manual page is 2 lines longer than the source :-)
1995-01-29 00:49:57 +00:00
.\" can do whatever you want with this file. If we meet some day, and you think
.\" this stuff is worth it, you can buy me a beer in return. Poul-Henning Kamp
.\" ---------------------------------------------------------------------------
.\"
$Id$ -> $FreeBSD$
1999-08-28 01:08:13 +00:00
.\" $FreeBSD$
This is a small little program used to execute a bad practice a clean way :-) It will read a file on stdin and write it as decimal integers on stdout, this is useful for embedding files in c-sources. There are a few places where this is needed, and this is a better way than the current practice of hand-editing the sources. The command: date | file2c 'const char date[] = {' ',0};' will produce: const char date[] = { 83,97,116,32,74,97,110,32,50,56,32,49,54,58,52,55,58,51,51,32,80,83,84, 32,49,57,57,53,10 ,0}; The manual page is 2 lines longer than the source :-)
1995-01-29 00:49:57 +00:00
.\"
Add '-s' option and update the manual page. With this option, it prints little more style(9) friendly output. For example: %file2c -n 8 -s -x 'const char data[] = {' '};' < /etc/motd const char data[] = { 0x46, 0x72, 0x65, 0x65, 0x42, 0x53, 0x44, 0x20, 0x37, 0x2e, 0x30, 0x2d, 0x43, 0x55, 0x52, 0x52, 0x45, 0x4e, 0x54, 0x20, 0x28, 0x42, 0x45, 0x41, 0x53, 0x54, 0x49, 0x45, 0x29, 0x20, 0x23, 0x30, 0x3a, 0x20, 0x57, 0x65, 0x64, 0x20, 0x4d, 0x61, 0x72, 0x20, 0x32, 0x31, 0x20, 0x31, 0x39, 0x3a, 0x30, 0x34, 0x3a, 0x33, 0x36, 0x20, 0x45, 0x44, 0x54, 0x20, 0x32, 0x30, 0x30, 0x37, 0x0a };
2007-03-23 00:00:22 +00:00
.Dd March 22, 2007
This is a small little program used to execute a bad practice a clean way :-) It will read a file on stdin and write it as decimal integers on stdout, this is useful for embedding files in c-sources. There are a few places where this is needed, and this is a better way than the current practice of hand-editing the sources. The command: date | file2c 'const char date[] = {' ',0};' will produce: const char date[] = { 83,97,116,32,74,97,110,32,50,56,32,49,54,58,52,55,58,51,51,32,80,83,84, 32,49,57,57,53,10 ,0}; The manual page is 2 lines longer than the source :-)
1995-01-29 00:49:57 +00:00
.Dt FILE2C 1
.Os
.Sh NAME
.Nm file2c
Nm does not always need an argument.
1997-07-02 06:30:51 +00:00
.Nd convert file to c-source
This is a small little program used to execute a bad practice a clean way :-) It will read a file on stdin and write it as decimal integers on stdout, this is useful for embedding files in c-sources. There are a few places where this is needed, and this is a better way than the current practice of hand-editing the sources. The command: date | file2c 'const char date[] = {' ',0};' will produce: const char date[] = { 83,97,116,32,74,97,110,32,50,56,32,49,54,58,52,55,58,51,51,32,80,83,84, 32,49,57,57,53,10 ,0}; The manual page is 2 lines longer than the source :-)
1995-01-29 00:49:57 +00:00
.Sh SYNOPSIS
Nm does not always need an argument.
1997-07-02 06:30:51 +00:00
.Nm
Apply style(9) to usage(), fix markup of the manpage.
2007-10-30 17:49:00 +00:00
.Op Fl sx
o Add option -n. The -n option takes a count and breaks the line after that many values have been printed. The line length is not considered anymore. o Add option -x. The -x option will cause the byte values to be printed in hexadecimal instead of decimal. o Bump WARNS to 6. o Update the manpage accordingly.
2005-05-15 06:26:59 +00:00
.Op Fl n Ar count
.Op Ar prefix Op Ar suffix
This is a small little program used to execute a bad practice a clean way :-) It will read a file on stdin and write it as decimal integers on stdout, this is useful for embedding files in c-sources. There are a few places where this is needed, and this is a better way than the current practice of hand-editing the sources. The command: date | file2c 'const char date[] = {' ',0};' will produce: const char date[] = { 83,97,116,32,74,97,110,32,50,56,32,49,54,58,52,55,58,51,51,32,80,83,84, 32,49,57,57,53,10 ,0}; The manual page is 2 lines longer than the source :-)
1995-01-29 00:49:57 +00:00
.Sh DESCRIPTION
The
Nm does not always need an argument.
1997-07-02 06:30:51 +00:00
.Nm
This is a small little program used to execute a bad practice a clean way :-) It will read a file on stdin and write it as decimal integers on stdout, this is useful for embedding files in c-sources. There are a few places where this is needed, and this is a better way than the current practice of hand-editing the sources. The command: date | file2c 'const char date[] = {' ',0};' will produce: const char date[] = { 83,97,116,32,74,97,110,32,50,56,32,49,54,58,52,55,58,51,51,32,80,83,84, 32,49,57,57,53,10 ,0}; The manual page is 2 lines longer than the source :-)
1995-01-29 00:49:57 +00:00
utility reads a file from stdin and writes it to stdout, converting each
o Add option -n. The -n option takes a count and breaks the line after that many values have been printed. The line length is not considered anymore. o Add option -x. The -x option will cause the byte values to be printed in hexadecimal instead of decimal. o Bump WARNS to 6. o Update the manpage accordingly.
2005-05-15 06:26:59 +00:00
byte to its decimal or hexadecimal representation on the fly.
Fix all the spelling mistakes I could find in the man pages for words that have at least 3 characters. MFC after: 1 week Thanks to: Music band ``Chingon'' for keeping me company while searching for these.
2005-07-31 03:30:48 +00:00
The byte values are separated by a comma.
o Add option -n. The -n option takes a count and breaks the line after that many values have been printed. The line length is not considered anymore. o Add option -x. The -x option will cause the byte values to be printed in hexadecimal instead of decimal. o Bump WARNS to 6. o Update the manpage accordingly.
2005-05-15 06:26:59 +00:00
This also means that the last byte value is not followed by a comma.
By default the byte values are printed in decimal, but when the
.Fl x
Apply style(9) to usage(), fix markup of the manpage.
2007-10-30 17:49:00 +00:00
option is given, the values will be printed in hexadecimal.
When
Add '-s' option and update the manual page. With this option, it prints little more style(9) friendly output. For example: %file2c -n 8 -s -x 'const char data[] = {' '};' < /etc/motd const char data[] = { 0x46, 0x72, 0x65, 0x65, 0x42, 0x53, 0x44, 0x20, 0x37, 0x2e, 0x30, 0x2d, 0x43, 0x55, 0x52, 0x52, 0x45, 0x4e, 0x54, 0x20, 0x28, 0x42, 0x45, 0x41, 0x53, 0x54, 0x49, 0x45, 0x29, 0x20, 0x23, 0x30, 0x3a, 0x20, 0x57, 0x65, 0x64, 0x20, 0x4d, 0x61, 0x72, 0x20, 0x32, 0x31, 0x20, 0x31, 0x39, 0x3a, 0x30, 0x34, 0x3a, 0x33, 0x36, 0x20, 0x45, 0x44, 0x54, 0x20, 0x32, 0x30, 0x30, 0x37, 0x0a };
2007-03-23 00:00:22 +00:00
.Fl s
option is given, each line is printed with a leading tab and each comma is
followed by a space except for the last one on the line.
This is a small little program used to execute a bad practice a clean way :-) It will read a file on stdin and write it as decimal integers on stdout, this is useful for embedding files in c-sources. There are a few places where this is needed, and this is a better way than the current practice of hand-editing the sources. The command: date | file2c 'const char date[] = {' ',0};' will produce: const char date[] = { 83,97,116,32,74,97,110,32,50,56,32,49,54,58,52,55,58,51,51,32,80,83,84, 32,49,57,57,53,10 ,0}; The manual page is 2 lines longer than the source :-)
1995-01-29 00:49:57 +00:00
.Pp
o Add option -n. The -n option takes a count and breaks the line after that many values have been printed. The line length is not considered anymore. o Add option -x. The -x option will cause the byte values to be printed in hexadecimal instead of decimal. o Bump WARNS to 6. o Update the manpage accordingly.
2005-05-15 06:26:59 +00:00
If more than 70 characters are printed on the same line, that line is
ended and the output continues on the next line.
With the
.Fl n
option this can be made to happen after the specified number of
byte values have been printed.
The length of the line will not be considered anymore.
To have all the byte values printed on the same line, give the
.Fl n
option a negative number.
This is a small little program used to execute a bad practice a clean way :-) It will read a file on stdin and write it as decimal integers on stdout, this is useful for embedding files in c-sources. There are a few places where this is needed, and this is a better way than the current practice of hand-editing the sources. The command: date | file2c 'const char date[] = {' ',0};' will produce: const char date[] = { 83,97,116,32,74,97,110,32,50,56,32,49,54,58,52,55,58,51,51,32,80,83,84, 32,49,57,57,53,10 ,0}; The manual page is 2 lines longer than the source :-)
1995-01-29 00:49:57 +00:00
.Pp
o Add option -n. The -n option takes a count and breaks the line after that many values have been printed. The line length is not considered anymore. o Add option -x. The -x option will cause the byte values to be printed in hexadecimal instead of decimal. o Bump WARNS to 6. o Update the manpage accordingly.
2005-05-15 06:26:59 +00:00
A prefix and suffix strings can be printed before and after the byte values
(resp.)
If a suffix is to be printed, a prefix must also be specified.
The first non-option word is the prefix, which may optionally be followed
by a word that is to be used as the suffix.
.Pp
This program is typically used to embed binary files into C source files.
The prefix is used to define an array type and the suffix is used to end
the C statement.
The
Apply style(9) to usage(), fix markup of the manpage.
2007-10-30 17:49:00 +00:00
.Fl n , s
Add '-s' option and update the manual page. With this option, it prints little more style(9) friendly output. For example: %file2c -n 8 -s -x 'const char data[] = {' '};' < /etc/motd const char data[] = { 0x46, 0x72, 0x65, 0x65, 0x42, 0x53, 0x44, 0x20, 0x37, 0x2e, 0x30, 0x2d, 0x43, 0x55, 0x52, 0x52, 0x45, 0x4e, 0x54, 0x20, 0x28, 0x42, 0x45, 0x41, 0x53, 0x54, 0x49, 0x45, 0x29, 0x20, 0x23, 0x30, 0x3a, 0x20, 0x57, 0x65, 0x64, 0x20, 0x4d, 0x61, 0x72, 0x20, 0x32, 0x31, 0x20, 0x31, 0x39, 0x3a, 0x30, 0x34, 0x3a, 0x33, 0x36, 0x20, 0x45, 0x44, 0x54, 0x20, 0x32, 0x30, 0x30, 0x37, 0x0a };
2007-03-23 00:00:22 +00:00
and
.Fl x
o Add option -n. The -n option takes a count and breaks the line after that many values have been printed. The line length is not considered anymore. o Add option -x. The -x option will cause the byte values to be printed in hexadecimal instead of decimal. o Bump WARNS to 6. o Update the manpage accordingly.
2005-05-15 06:26:59 +00:00
options are useful when the binary data represents a bitmap and the output
needs to remain readable and/or editable.
Fonts, for example, are a good example of this.
mdoc(7) police: use certified section headers wherever possible.
2000-11-17 11:44:16 +00:00
.Sh EXAMPLES
This is a small little program used to execute a bad practice a clean way :-) It will read a file on stdin and write it as decimal integers on stdout, this is useful for embedding files in c-sources. There are a few places where this is needed, and this is a better way than the current practice of hand-editing the sources. The command: date | file2c 'const char date[] = {' ',0};' will produce: const char date[] = { 83,97,116,32,74,97,110,32,50,56,32,49,54,58,52,55,58,51,51,32,80,83,84, 32,49,57,57,53,10 ,0}; The manual page is 2 lines longer than the source :-)
1995-01-29 00:49:57 +00:00
The command:
.Bd -literal -offset indent
date | file2c 'const char date[] = {' ',0};'
.Ed
.Pp
will produce:
.Bd -literal -offset indent
const char date[] = {
83,97,116,32,74,97,110,32,50,56,32,49,54,58,50,56,58,48,53,
32,80,83,84,32,49,57,57,53,10
,0};
.Ed
Reference in New Issue Copy Permalink