Skip to content

Commit

Permalink
add simple man page [#5]
Browse files Browse the repository at this point in the history
  • Loading branch information
stsp committed Jun 14, 2024
1 parent d87f827 commit c8ce7f9
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 0 deletions.
1 change: 1 addition & 0 deletions debian/dj64-dev.install
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ usr/i386-pc-dj64/share/*
usr/bin/*
usr/share/pkgconfig/dj64.pc
usr/share/pkgconfig/dj64static.pc
usr/share/man/man1/*
1 change: 1 addition & 0 deletions dj64.spec.rpkg
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ This package contains tools and headers for building dj64-enabled programs.
%{_bindir}/*
%{_datadir}/pkgconfig/dj64.pc
%{_datadir}/pkgconfig/dj64static.pc
%doc %{_mandir}/man1/*
%end

%package dj64-devel-static
Expand Down
2 changes: 2 additions & 0 deletions makefile
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ install_dj64:
$(INSTALL) -m 0644 dj64.pc $(DESTDIR)$(PREFIX)/share/pkgconfig
$(INSTALL) -m 0644 dj64_s.pc $(DESTDIR)$(PREFIX)/share/pkgconfig
$(INSTALL) -m 0644 dj64static.pc $(DESTDIR)$(PREFIX)/share/pkgconfig
$(INSTALL) -d $(DESTDIR)$(PREFIX)/share/man/man1
$(INSTALL) -m 0644 man/*.1 $(DESTDIR)$(PREFIX)/share/man/man1

install_djdev64:
$(INSTALL) -d $(DESTDIR)$(PREFIX)/share
Expand Down
41 changes: 41 additions & 0 deletions man/dj64-gcc.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
.\" -*- nroff -*- (This is for Emacs)
.TH dj64-gcc 1 "2024-06-13" "Version 0.1" "Development"
.SH NAME
dj64-gcc \- cross-compile 64-bit DOS programs
.SH SYNOPSIS
.B dj64-gcc
[
.B gcc_opts
]
.B -o <out_file>.o
.B -c <in_file>.[cSs]
.PP
.SH DESCRIPTION
.B dj64-gcc
compiles the C or assembler source files into an intermediate object files.
It is used by dj64-provided
.I dj64.mk
makefile hook and should not be called directly. The intermediate object
files compiled with
.I dj64-gcc
are further processed in
.I dj64.mk
and you get a different object files as an output.

.SH "EXAMPLES"
.TP
dj64-gcc -Wall -Os -ggdb3 -DREV=\\"0.1\\" -I. -o command.o -c command.c
.TP
dj64-gcc -o asm.o -c asm.S

.SH "NOTES"
You may want to use
.I dj64-gcc
directly only if you use non-make-based build system, like meson.

You can't freely reorder command-line arguments. Please use the order
specified in this man page.

.SH "AUTHOR"
.TP
[email protected] (@stsp on github)

0 comments on commit c8ce7f9

Please sign in to comment.