SDOP(1)

πŸ’– SDOP(1) β€” the manual, but make it make sense πŸ’–

okay so bestie, you've stumbled into the SDOP(1) page from the General Commands Manual and honestly? you're about to have a time. Sit down, grab a strawberry πŸ“, and let's get into it.


✨ NAME ✨

SDoP β€” a Simple DocBook Processor. that's it, that's the name, and it's giving exactly what it says on the tin πŸ’…


🌸 SYNOPSIS 🌸

sdop [options] [source file]

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so here's the whole vibe: sdop reads DocBook XML input, processes it into page images, and writes the result out as PostScript. then you can turn that into a PDF using an application such as ps2pdf and live your best life.

and why is SDoP "simple", you ask? two reasons, bestie, and neither of them is a read:

  • (a) it does not check that the input conforms to the DTD πŸ™ˆ
  • (b) it supports only a simple subset of DocBook features

if you don't hand it a source file, it just reads the standard input. easy.


πŸŽ€ OPTIONS πŸŽ€

  • -d β€” produce debugging output. add +all and you get voluminous output (like, truly a lot, no cap); some other words can be used to generate subsets of this.
  • -help or --help β€” list the available options. iconic behaviour, honestly.
  • -o <output file> β€” specify an output file. to specify the standard output, use "-". the default is to replace the input file's extension with .ps, or to write to the standard output if the input is the standard input.
  • -p <pagelist> β€” output only the given pages, counting from the start of the body of the document, that is, after the front matter and preface(s), if any. page numbers in the list are comma-separated, and ranges can be given using a hyphen.
  • -pf <pagelist> β€” output only the given pages from the front matter, counting from the very first page of the document. page numbers in the list are comma-separated, and ranges can be given using a hyphen.
  • -q β€” suppress warnings for unsupported DocBook features (which are ignored). this overrides any setting in the input file.
  • -qc β€” suppress warnings for unsupported characters. this overrides any setting in the input file.
  • -S <colon-separated directory list> β€” the given directories are searched in order for SDoP's shared data files, before searching the installed directory (usually /usr/local/share/sdop). this overrides any setting in an SDOP_SHARE environment variable.
  • -w β€” do not suppress warnings for unsupported DocBook features (which are ignored). this overrides any setting in the input file.
  • -wc β€” do not suppress warnings for unsupported characters. this overrides any setting in the input file.
  • -v or --version β€” show SDoP's version and list any optional facilities that this implementation supports. main character energy, fr fr.

and a lil extra tea about page lists: a page list for -p (but not for -pf) may include odd or even, to further restrict which pages are output. if you want only odd or even pages from the frontmatter, you can use, for example, -p odd with an appropriate -pf setting. iykyk πŸ’…


🌈 ENVIRONMENT 🌈

the environment variable SDOP_SHARE may be set to a colon-separated list of directories. these are searched in order for SDoP's shared data files, before searching the installed directory (usually /usr/local/share/sdop). the -S option can be used to override SDOP_SHARE. periodt.


πŸ”₯ FURTHER INFORMATION πŸ”₯

the SDoP manual gives a full description of the program and the features that it provides. go read it, bestie, it's lowkey a whole thing.


πŸ’€ DIAGNOSTICS AND RETURN CODES πŸ’€

error messages are written to the standard error stream. the return code is 0 for success, and 1 if there have been any diagnostics more serious than a warning.

ngl, 1 is the "something's up" number. 0 is the slay number. that's the whole system 🫢

πŸ‘‘ AUTHOR πŸ‘‘

Philip Hazel Cambridge, England.


⭐ REVISION ⭐

Last updated: 23 November 2013 Copyright (c) 2013 Philip Hazel


okay and that's the whole page, bestie!! πŸ’–βœ¨πŸŽ€πŸ¦‹πŸŒΈπŸ’…πŸ«Ά

this was the SDOP(1) manual from the General Commands Manual, last updated 23 November 2013, and the copyright belongs to Philip Hazel, 2013 β€” so like, credit where credit is due, always πŸ‘‘ now go process some DocBook, you absolute icon πŸŒˆβ­πŸ’œ

πŸ“¦ where this page comes from