From ca2dd62a0264c4dbe836f6fa01c2b8e3cf2a6091 Mon Sep 17 00:00:00 2001 From: Sam Anthony Date: Fri, 28 Jul 2023 21:47:10 -0230 Subject: split man page into multiple files --- Makefile | 6 ++- doc/cmd.1 | 48 +++++++++++++++++++++++ doc/const.1 | 9 +++++ doc/func.1 | 33 ++++++++++++++++ doc/intro.1 | 8 ++++ doc/op.1 | 25 ++++++++++++ pfc.1 | 128 ------------------------------------------------------------ 7 files changed, 127 insertions(+), 130 deletions(-) create mode 100644 doc/cmd.1 create mode 100644 doc/const.1 create mode 100644 doc/func.1 create mode 100644 doc/intro.1 create mode 100644 doc/op.1 delete mode 100644 pfc.1 diff --git a/Makefile b/Makefile index 35d3fd1..5494fe0 100644 --- a/Makefile +++ b/Makefile @@ -13,11 +13,13 @@ clean: rm -f pfc install: - go build + go build -buildvcs=false cp pfc ${DESTDIR}${PREFIX}/bin chmod 755 ${DESTDIR}${PREFIX}/bin/pfc mkdir -p ${DESTDIR}${MANPREFIX}/man1 - sed "s/VERSION/${VERSION}/g" < pfc.1 > ${DESTDIR}${MANPREFIX}/man1/pfc.1 + cat doc/{intro.1,cmd.1,op.1,func.1,const.1} | \ + sed "s/VERSION/${VERSION}/g" > \ + ${DESTDIR}${MANPREFIX}/man1/pfc.1 chmod 644 ${DESTDIR}${MANPREFIX}/man1/pfc.1 uninstall: diff --git a/doc/cmd.1 b/doc/cmd.1 new file mode 100644 index 0000000..83f1c21 --- /dev/null +++ b/doc/cmd.1 @@ -0,0 +1,48 @@ +.SS Keyboard commands +. +.TP +.B Shift-q +Quit. +. +.TP +.B [0..9] +Enter a digit into the input buffer. +pfc works with floating point numbers so the +.B . +character is OK as well. +. +.TP +.B Backspace +Remove a digit from the input buffer. +. +.TP +.B Enter +Push the number in the input buffer to the stack. +. +.TP +.B Shift-j +Swap the bottom (most recently pushed) item on the stack with the input buffer. +If the input buffer is empty this simply moves the most recently pushed item +back into the input buffer. +. +.TP +.B Shift-k +The same as +.BR Shift-j . +. +.TP +.B Shift-d +Delete the contents of the input buffer. +. +.TP +.B Shift-c +Delete the contents of the input buffer and the stack. +. +.TP +.B Shift-a +Toggle between degree and radian mode. +. +.TP +.B Shift-n +Negation. If there is a number in the buffer, negate it. Otherwise, negate the +bottom number in the stack. diff --git a/doc/const.1 b/doc/const.1 new file mode 100644 index 0000000..a4eb3b6 --- /dev/null +++ b/doc/const.1 @@ -0,0 +1,9 @@ +.SS Constants +. +.TP +.B pi +Archimedes’ constant (π). +. +.TP +.B e +Euler’s number (e). diff --git a/doc/func.1 b/doc/func.1 new file mode 100644 index 0000000..364cdf6 --- /dev/null +++ b/doc/func.1 @@ -0,0 +1,33 @@ +.SS Functions +. +.TP +.B sin +Sine function. +. +.TP +.B cos +Cosine function. +. +.TP +.B tan +Tangent function. +. +.TP +.B asin +Inverse sine function. +. +.TP +.B acos +Inverse cosine function. +. +.TP +.B atan +Inverse tangent function. +. +.TP +.B deg +Convert radians to degrees. +. +.TP +.B rad +Convert degrees to radians. diff --git a/doc/intro.1 b/doc/intro.1 new file mode 100644 index 0000000..1a237c5 --- /dev/null +++ b/doc/intro.1 @@ -0,0 +1,8 @@ +.TH PFC 1 pfc\-VERSION +.SH NAME +pfc \- postfix calculator +.SH SYNOPSIS +.B pfc +.SH DESCRIPTION +pfc is an interactive postfix, or reverse Polish notation, calculator. +.SH USAGE diff --git a/doc/op.1 b/doc/op.1 new file mode 100644 index 0000000..1122576 --- /dev/null +++ b/doc/op.1 @@ -0,0 +1,25 @@ +.SS Operators +. +.TP +.B + +Addition. +. +.TP +.B - +Subtraction. +. +.TP +.B * +Multiplication. +. +.TP +.B / +Division. +. +.TP +.B % +Modulo/remainder. +. +.TP +.B ^ +Exponentiation. diff --git a/pfc.1 b/pfc.1 deleted file mode 100644 index 6229813..0000000 --- a/pfc.1 +++ /dev/null @@ -1,128 +0,0 @@ -.TH PFC 1 pfc\-VERSION -.SH NAME -pfc \- postfix calculator -.SH SYNOPSIS -.B pfc -.SH DESCRIPTION -pfc is an interactive postfix, or reverse Polish notation, calculator. -. -.SH USAGE -. -.SS Keyboard commands -. -.TP -.B Shift-q -Quit. -. -.TP -.B [0..9] -Enter a digit into the input buffer. -pfc works with floating point numbers so the -.B . -character is OK as well. -. -.TP -.B Backspace -Remove a digit from the input buffer. -. -.TP -.B Enter -Push the number in the input buffer to the stack. -. -.TP -.B Shift-j -Swap the bottom (most recently pushed) item on the stack with the input buffer. -If the input buffer is empty this simply moves the most recently pushed item -back into the input buffer. -. -.TP -.B Shift-k -The same as -.BR Shift-j . -. -.TP -.B Shift-d -Delete the contents of the input buffer. -. -.TP -.B Shift-c -Delete the contents of the input buffer and the stack. -. -.TP -.B Shift-a -Toggle between degree and radian mode. -. -.TP -.B Shift-n -Negation. If there is a number in the buffer, negate it. Otherwise, negate the -bottom number in the stack. -. -.SS Operators -. -.TP -.B + -Addition. -. -.TP -.B - -Subtraction. -. -.TP -.B * -Multiplication. -. -.TP -.B / -Division. -. -.TP -.B % -Modulo/remainder. -. -.TP -.B ^ -Exponentiation. -. -.SS Functions -. -.TP -.B sin -Sine function. -. -.TP -.B cos -Cosine function. -. -.TP -.B tan -Tangent function. -. -.TP -.B asin -Inverse sine function. -. -.TP -.B acos -Inverse cosine function. -. -.TP -.B atan -Inverse tangent function. -. -.TP -.B deg -Convert radians to degrees. -. -.TP -.B rad -Convert degrees to radians. -. -.SS Constants -. -.TP -.B pi -Archimedes’ constant (π). -. -.TP -.B e -Euler’s number (e). -- cgit v1.2.3