diff options
| author | giraffedata <giraffedata@9d0c8265-081b-0410-96cb-a4ca84ce46f8> | 2023-11-26 19:57:02 +0000 |
|---|---|---|
| committer | giraffedata <giraffedata@9d0c8265-081b-0410-96cb-a4ca84ce46f8> | 2023-11-26 19:57:02 +0000 |
| commit | ecf0ef4f0a678ec5b0c58d086417aaeb0f971148 (patch) | |
| tree | 4de953a3f4c21561512b1cc75aee282a8f064236 | |
| parent | 0d897de7695b764b2dabd18aab09776b42ee3ec3 (diff) | |
| download | netpbm-mirror-ecf0ef4f0a678ec5b0c58d086417aaeb0f971148.tar.gz netpbm-mirror-ecf0ef4f0a678ec5b0c58d086417aaeb0f971148.tar.xz netpbm-mirror-ecf0ef4f0a678ec5b0c58d086417aaeb0f971148.zip | |
miscellaneous update
git-svn-id: http://svn.code.sf.net/p/netpbm/code/userguide@4787 9d0c8265-081b-0410-96cb-a4ca84ce46f8
| -rw-r--r-- | libsystem.html | 45 | ||||
| -rw-r--r-- | pnmindex.html | 6 | ||||
| -rw-r--r-- | pnmpad.html | 22 |
3 files changed, 63 insertions, 10 deletions
diff --git a/libsystem.html b/libsystem.html index 4ccf57cd..9ef36a14 100644 --- a/libsystem.html +++ b/libsystem.html @@ -398,8 +398,8 @@ another address in your process' memory. <p>The Standard Input feeder for this is called <b>pm_feed_from_memory</b>. The Standard Output accepter is <b>pm_accept_to_memory</b>. -<p>For both of these, the argument is the address of a <b>struct -bufferDesc</b>, which is defined as follows: +<p>For both of these, the argument is a pointer to a <b>struct bufferDesc</b>, +which is defined as follows: <pre> struct bufferDesc { @@ -424,6 +424,47 @@ able to write everything to a pipe that it wanted to, case. +<h3>File Stream</h3> + +<p>These routines are for using an actual file as input or output. + I.e. Standard Input comes from a file and Standard Output goes to a file. + You open the file and create a libc file stream (type FILE) from it and pass + that stream object to the standard input feeder or standard output accepter. + +<p>When you do this (using output as an example), your process writes to + Standard Output, which is a pipe, the standard output accepter then reads + from that pipe into a buffer, and then the standard output accepter writes + from that buffer to your file. You could alternatively just arrange for the + Standard Input or Output of your process to be the file and skip a copy, but + it might be more complex coding. + +<p>Note that if the calling program's Standard Output is already set up + as the file to which you want your process' output to go, you + don't need this. All you have to do is decline to specify a Standard + Output accepter (use NULL in place of the Standard Output accepter pointer) + and your process' output will go there. + +<p>The Standard Input feeder for this is called <b>pm_feed_from_filestream</b>. +The Standard Output accepter is <b>pm_accept_to_filestream</b>. + +<p>For both of these, the argument is a pointer to a Standard C library + FILE object. + +<p>Example: + + <pre> + <code> + int termStatus; + FILE * myFileP; + myFileP = fopen("tmp/myfile", "r"); + pm_system2(pm_feed_from_filestream, myFileP, + NULL, NULL, + "grep myword", &termstatus); + </code> + </pre> + +<p>These routines were new in Netpbm 11.05 (December 2023). + <h3>Pamtuple</h3> <p>These routines are for when you have images in memory in the data diff --git a/pnmindex.html b/pnmindex.html index 785fadbc..29189d14 100644 --- a/pnmindex.html +++ b/pnmindex.html @@ -2,7 +2,7 @@ <html><head><title>Pnmindex User Manual</title></head> <body> <h1>pnmindex</h1> -Updated: 08 November 2023 +Updated: 23 November 2023 <br> <a href="#index">Table Of Contents</a> @@ -85,7 +85,9 @@ is white and the labels are black lettering on white background, but the <dt><b>-title=</b><i>title</i> <dd> -This specifies a title top place at the top of the image. +This specifies a title to be placed at the top of the image. +<p>The <i>title</i> value must be in ASCII. Characters that are not valid +ASCII are not rendered. <p>Default is no title. diff --git a/pnmpad.html b/pnmpad.html index c48b55f5..f20f7fea 100644 --- a/pnmpad.html +++ b/pnmpad.html @@ -2,7 +2,7 @@ <html><head><title>Pnmpad User Manual</title></head> <body> <h1>pnmpad</h1> -Updated: 25 December 2021 +Updated: 14 November 2023 <br> <a href="#index">Table Of Contents</a> @@ -208,11 +208,21 @@ This causes verbose messages. <h2 id="history">HISTORY</h2> -<p>Before February 2002, <b>pnmpad</b> had a different option syntax -which was less expressive and not like conventional Netpbm programs. -That syntax is still understood by <b>pnmpad</b> for backward -compatibility, but not documented or supported for future use. - +<p>The command line syntax was originally more of a traditional Unix syntax, + with single-character margin size options <b>-l</b>, <b>-r</b>, <b>-t</b>, + and <b>-b</b> that took arguments concatenated to the option name, such + as <b>-l50</b>. This is in contrast to the more modern syntax used by + essentially all Netpbm programs, in which an option such as <b>-left</b> + (which can still be abbreviated <b>-l</b>) must have its name and value as + separate command line arguments (e.g. <b>-l 50</b>). + + The new syntax was accepted and the old syntax deprecated and removed from + documentation in Netpbm 9.25 (March 2002), and was no longer accepted in + Netpbm 11.05 (December 2023). + + The code was broken for most of that time so that an attempt to use the old + syntax would fail anyway. The bug was discovered only in testing; no user + ever reported encountering it. <h2 id="seealso">SEE ALSO</h2> |