# README for pdp10-tools
# Copyright (C) 2013-2025  Mikael Pettersson <[email protected]>
#
# This file is part of pdp10-tools.
#
# pdp10-tools is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# pdp10-tools is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with pdp10-tools.  If not, see <http://www.gnu.org/licenses/>.


PDP10-TOOLS
===========

pdp10-tools is a collection of utilities for pdp10-elf:

elf2boot:	converts PDP-10 ELF-36 and ELF-64 executables to KLH10-bootable files
libelf:		reading and writing ELF-32, ELF-36, and ELF-64 object files
sim:            a simulator for running PDP-10 ELF-36 executables on a
                hypothetical fully-extended PDP10 called the KE10
stdio9:		reading and writing nonet-based files on an octet-based host

The following components were developed for the PDP-10 ELF-36 project
and are now deprecated given the PDP-10 ELF-64 support in GNU binutils:

ar:		archiver for pdp10-elf object files
archive:	reading and writing archives containing pdp10-elf object files
as:		assembler producing pdp10-elf object files
		intended primarily as an assembler for GCC output;
		the syntax is modelled after normal UNIX/ELF syntax
		rather than classic TOPS-10, TOPS-20, or ITS syntax
ld:		linker for pdp10-elf object files
nm:		list symbols from pdp10-elf object files
od:		file dumper for binary files with 9-bit bytes (nonets)
ranlib:		add an index to a pdp10-elf archive (same as `ar s`)
readelf:	display information about pdp10-elf object files,
		extended with an option to disassemble .text sections
8to9:		a utility to convert octet files to nonet files and back

See the TODO file for known omissions and planned improvements.