PALBART(1)

okay bestie, pull up a chair and let me tell you about PALBART(1) โ€” the manual page for palbart, straight out of the General Commands Manual section. She's a cross-assembler for PDP-8 assembly and she's thriving. Let's get into it ๐Ÿ’–


๐ŸŽ€ NAME ๐ŸŽ€

palbart โ€” BART enhanced PDP8 crossassembler ๐Ÿฆ‹


โœจ SYNOPSIS โœจ

palbart [options]inputfile

yeah that's it. no space between [options] and inputfile, that's just how she is, we respect it ๐Ÿ’…


๐ŸŒธ DESCRIPTION ๐ŸŒธ

okay so this manual page documents the palbart command briefly โ€” short and sweet, like a story post. What she actually is is a cross-assembler for PDP/8 assembly language programs. ๐Ÿ’ป

She'll produce an output file in bin format, rim format, or โ€” if you use the appropriate pseudo-ops โ€” a combo of rim and bin formats together. A listing file is always produced (no opt-out, she's committed), and optionally you also get a symbol table and/or a symbol cross-reference (aka a concordance). ๐Ÿ‘‘

The permanent symbol table can be output in a form that may be read back in, so you can build yourself a customized permanent symbol table. Very self-sustaining, very main character energy.

Any detected errors get output to a separate file โ€” it tells you the filename where they were detected, plus the line number, column number and the error message, and it marks the error in the listing file too. Double coverage, she's thorough like that. ๐Ÿ˜Œ

The following file name extensions are used:

  • .pal โ€” source code (input)
  • .lst โ€” assembly listing (output)
  • .bin โ€” assembly output in DEC's bin format (output)
  • .rim โ€” assembly output in DEC's rim format (output)
  • .err โ€” assembly errors detected (if any) (output)
  • .prm โ€” permanent symbol table in form suitable for reading after the EXPUNGE pseudo-op.

๐Ÿ’… OPTIONS ๐Ÿ’…

A summary of options is included below. Here's the whole roster, no skips:

  • -$ โ€” Don't require a $ at end of file
  • -a โ€” Enable additional features not compatible with PAL8.
  • -d โ€” Show symbol table at end of assembly
  • -e โ€” Generate error if link generated
  • -h โ€” Display help
  • -l โ€” Allow generation of links and literals (default)
  • -n โ€” Don't allow redefinition of permanent symbols
  • -p โ€” Generate a file with the permanent symbols in it. (To get the current symbol table, assemble a file than has only a $ in it.)
  • -r โ€” Produce output in rim format (default is bin format)
  • -t N โ€” Set tab stops to N
  • -v โ€” Display version information
  • -x โ€” Generate a cross-reference (concordance) of user symbols

๐Ÿฆ‹ ADDITIONAL FEATURES ๐Ÿฆ‹

So the additional features flag (-a, bestie, keep up ๐Ÿ’–) enables functions that are not compatible with the PAL8 assembler. Currently only the TITLE and BANK pseudo operations are enabled with this function. And ngl, there are likely other incompatibilities that are not under this flag. ๐Ÿ™ˆ so like, proceed with awareness.


๐Ÿ˜ญ DIAGNOSTICS ๐Ÿ˜ญ

Assembler error diagnostics get output to an error file and inserted in the listing file. Each line in the error file has the form:

<filename>(<line>:<col>) : error:  <message> at Loc = <loc>

An example error message is:

bintst.pal(17:9) : error:  undefined symbol "UNDEF" at Loc = 07616

The error diagnostics put in the listing start with a two character error code (if appropriate) and a short message. A carat '^' is placed under the item in error if appropriate. An example error message is:

      17 07616 3000          DCA     UNDEF
   UD undefined                      ^
      18 07617 1777          TAD  I  DUMMY

When an indirect is generated, an at character '@' is placed after the the instruction value in the listing as an indicator as follows:

      14 03716 1777@         TAD     OFFPAG

Undefined symbols are marked in the symbol table listing by prepending a '?' to the symbol. Redefined symbols are marked in the symbol table listing by prepending a '#' to the symbol. Examples are:

  #REDEF   04567
   SWITCH  07612
  ?UNDEF   00000

Refer to the code for the diagnostic messages generated. (iykyk, the code is the source of truth here ๐Ÿ“–)


๐Ÿ’€ BUGS ๐Ÿ’€

okay so, full transparency time:

Only a minimal effort has been made to keep the listing format anything like the PAL-8 listing format. So don't come for her about aesthetics. ๐Ÿซ 

The RIMPUNch and BINPUNch pseudo-ops do not change the binary output file type that was specified on startup. This was intentional and and allows rim formatted data to be output prior to the actual binary formatted data. On UN*X style systems, the same effect can be achieved using the "cat" command, but on DOS/Windows systems, doing this was a major chore. ๐Ÿ˜ฎโ€๐Ÿ’จ

The floating point input does not generate values exactly as the DEC compiler does. The author worked out several examples by hand and believes that this implementation is slightly more accurate. If that's mistaken, let them know and, if possible, a better method of generating the values. ๐Ÿ‘€


๐ŸŒˆ HISTORICAL NOTE ๐ŸŒˆ

This assembler was written to support the fleet of PDP-8 systems used by the Bay Area Rapid Transit System. As of early 1997, this includes about 40 PDP-8/E systems driving the train destination signs in passenger stations. ๐Ÿš†โœจ literally running the trains, iconic behaviour.


๐Ÿ“š REFERENCES ๐Ÿ“š

This assembler is based on the pal assembler by:

  • Douglas Jones <jones@cs.uiowa.edu> and
  • Rich Coon <coon@convexw.convex.com>

๐Ÿงš DISCLAIMER ๐Ÿงš

  • See the symbol table for the set of pseudo-ops supported.
  • See the code for pseudo-ops that are not standard for PDP/8 assembly.
  • Refer to DEC's "Programming Languages (for the PDP/8)" for complete documentation of pseudo-ops.
  • Refer to DEC's "Introduction to Programming (for the PDP/8)" or a lower level introduction to the assembly language.

๐Ÿ™ˆ WARRANTY ๐Ÿ™ˆ

If you don't like it the way it works or if it doesn't work, that's tough. You're welcome to fix it yourself. That's what you get for using free software. ๐Ÿ’€ periodt. she said what she said.


This is free software. There is no fee for using it. You may make any changes that you wish and also give it away. If you can make a commercial product out of it, fine, but do not put any limits on the purchaser's right to do the same. If you improve it or fix any bugs, it would be nice if you told me and offered me a copy of the new version.

Gary Messenbrink <gam@rahul.net>


โญ VERSIONS โญ

okay the whole glow-up timeline, every single entry, no gatekeeping:

  • v1.0 โ€” 12Apr96 โ€” GAM โ€” Original
  • v1.1 โ€” 18Nov96 โ€” GAM โ€” Permanent symbol table initialization error.
  • v1.2 โ€” 20Nov96 โ€” GAM โ€” Added BINPUNch and RIMPUNch pseudo-operators.
  • v1.3 โ€” 24Nov96 โ€” GAM โ€” Added DUBL pseudo-op (24 bit integer constants).
  • v1.4 โ€” 29Nov96 โ€” GAM โ€” Fixed bug in checksum generation.
  • v2.1 โ€” 08Dec96 โ€” GAM โ€” Added concordance processing (cross reference).
  • v2.2 โ€” 10Dec96 โ€” GAM โ€” Added FLTG psuedo-op (floating point constants).
  • v2.3 โ€” 2Feb97 โ€” GAM โ€” Fixed paging problem in cross reference output.
  • v2.4 โ€” 11Apr97 โ€” GAM โ€” Fixed problem with some labels being put in cross reference multiple times.
  • v2.9 โ€” 23Jun13 โ€” DJG David Gesswein djg@pdp8online.com โ€” Combined versions found online and fixed many bugs. Used source from v2.5 03Nov07 RK and v2.6 14Jul03 PNT.

๐Ÿ“ AUTHOR ๐Ÿ“

This manual page was written by Vince Mulhollon <vlm@debian.org>, for the Debian GNU/Linux system (but may be used by others). ๐Ÿซถ


and that's the whole page bestie!! this little queen is dated June 23, 2013 and she's still serving. go assemble something gorgeous with her ๐Ÿ’–โœจ๐ŸŽ€