FM2PS(1)

πŸ“¦
version 2.001+1 Β· 3 versions
, in debian trixie, ubuntu noble, ubuntu questing

✨ FM2PS πŸ’…

okay bestie, welcome to fm2ps, section 1 of the manual β€” the batch processing utility page. pull up a chair, grab a boba, we're doing Frame files today and honestly? it's giving iconic. πŸŽ€


🌸 NAME 🌸

fm2ps β€” Batch Processing Utility πŸ’–


πŸ¦‹ PURPOSE πŸ¦‹

so sdfbatch is a preprocessor for fmbatch, which is FrameMaker's command-line driven batch processing utility. that's the whole vibe. it goes in front and sets things up. periodt. ✨


🌈 USAGE 🌈

here's the whole shape of it, no cap:

 usage  : fm2ps [-h[help]] [-f fmt_file]
         [-F fmt_what] [-u] [-p[print_doc]]
         [-P paper_size] [-s[save_ext]]
         [-S save_fmt] [-n] [-t timeout]
         frame_file ...
purpose: convert Frame files to PostScript
version: 2.000    (SDF 2.001)

and the options, laid out for you because we love clarity in this house:

  • -h β€” display help on options πŸ‘‘
  • -f β€” formats file
  • -F β€” formats to import
  • -u β€” update documents
  • -p β€” print documents
  • -P β€” paper size name
  • -s β€” save extension
  • -S β€” save file format
  • -n β€” output the batch file (instead of calling fmbatch)
  • -t β€” timeout for printer driver to generate ps

πŸ’œ DESCRIPTION πŸ’œ

give it a set of FrameMaker documents and sdfbatch will literally do all of this for you:

  • change the formatting of the documents (ala Use Formats From) πŸ’…
  • update the documents (i.e. cross-references, etc.) πŸ”„
  • print the documents πŸ–¨οΈ
  • save the documents in a nominated file format πŸ’Ύ

🫢 the -h help situation

the -h option provides help. if you specify it with no parameter, you get a brief description of each option β€” cute lil snack. but if you wanna see the attributes for one specific option, just pass the option letter as the parameter. iykyk. ✨

πŸŽ€ changing formatting

to change formatting, use the -f option to name the file you're importing the formats from.

the -F option says what formats get imported, and its argument is a set of the characters in this table right here:

  • p β€” Paragraph formats
  • f β€” Font formats
  • l β€” Page layouts
  • c β€” Cross references
  • v β€” Variables
  • r β€” Reference page contents
  • t β€” Table formats
  • x β€” Conditional text
  • k β€” Color
  • m β€” math
  • B β€” Preserve manual page breaks
  • O β€” Preserve other formatting overrides
by default, all formats are imported. yes, ALL of them. she's generous. πŸ’–

πŸ”„ updating

to update documents, use the -u option. that's it, that's the section.

πŸ–¨οΈ printing

to print documents, use the -p option. if you don't hand it a parameter, the file gets printed to the default printer. want a PostScript file instead? pass the "file" keyword as the parameter. orrrr the parameter can be the name of a print settings file. your call, bestie. ✨

πŸ“„ paper size

when generating a PostScript file, you can set the paper size with the -P option. the default value is global.

so here's the tea: the paper size name is actually mapped to a print settings file called paper_size.fmver in the stdlib library directory. fmver is typically either fm4 or fm5, depending on which version of FrameMaker you're using. 🌸

πŸ’Ύ saving

to save documents, use the -s option. by default, this saves each file. wanna change the extension? just supply an argument to the -s option. slay.

πŸ¦‹ picking a save format

to specify a different format, use the -S option. possible values are:

  • m β€” MIF
  • a β€” line-oriented ASCII
  • t β€” paragraph-oriented ASCII
  • d β€” Frame document
  • l β€” View-Only Frame document
  • - β€” file's current format [default]
⚠️ take care with the file extension β€” any existing files will be replaced without warning. no undo, no takebacks, no "wait bestie". 😭

πŸ” the -n debugging option

the -n option causes the generated fmbatch file to be output. i.e. fmbatch is not called. this option is useful for debugging. πŸ•΅οΈβ™€οΈ

⏱️ the -t timeout

the -t option lets you tune the time-out used when waiting for the print driver to generate a PostScript file. the default value is 300 seconds (i.e. 5 minutes). generous queen. πŸ‘‘

🎯 mixing and matching

a combination of the f, u, p and s options can be supplied if more that one operation is required per file. for example, you may wish to import formats and then save the resultant file. for each file, the operations are always done in the following order:

  1. formatting
  2. updating
  3. printing
  4. saving
Note: Not all of the values documented for the -F and -S options may be supported in Frame versions before 4.0, and additional values may be supported in future versions. As such, the values supplied to these options are simply embedded in the generated sdfbatch file. i.e. no checking is done on the value. This behaviour is considered a feature. πŸ’… (fr fr, that's what it says.)

🌟 EXAMPLES 🌟

to format and print a set of files:

sdfbatch -fmyfmts.doc -p *.doc

to convert mif files to binary files:

sdfbatch -sdoc -Sd *.mif

to copy Frame variables from a file to a set of files:

sdfbatch -fvariable.mif -Fv -s *.doc

and that's the whole page, bestie!! 🫢 this was perl v5.36.0, dated 2023-08-02 β€” shoutout to the original FM2PS(1) crew, mwah, iconic, no notes. πŸ’–βœ¨πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from