diff --git a/Makefile b/Makefile index 7ff2444..8037a76 100644 --- a/Makefile +++ b/Makefile @@ -8,3 +8,5 @@ all: src/main.c src/printevents.c src/mkevent.c install: src/nc install src/nc $(PREFIX)/bin + install man/nc.1 $(PREFIX)/share/man/man1 + gzip $(PREFIX)/share/man/man1/nc.1 diff --git a/config.mk b/config.mk new file mode 100644 index 0000000..d3d698c --- /dev/null +++ b/config.mk @@ -0,0 +1,9 @@ +# +# config.mk +# + +PREFIX = /usr + +CC = cc +CFLAGS = -O2 -fstack-protector-strong -static -pie +LDFLAGS = -static diff --git a/man/nc.1 b/man/nc.1 new file mode 100644 index 0000000..99d7a97 --- /dev/null +++ b/man/nc.1 @@ -0,0 +1,21 @@ +.\" Manpage for nc. +.TH man 1 "14 April 2023" "1.0" Everest Linux Manual" +.SH NAME +nc \- to-do list which outputs to the command line +.SH SYNPOSIS +nc -l -n DATE EVENT_NAME +.SH DESCRIPTION +nc is a to-do list. It outputs contents from a text file, defined in config.h (usually /etc/nc/events). nc is designed for *NIX systems. +.SH OPTIONS +.TP +.BR \-l +lists all events in NC_ENTRIES_FILE +.TP +.BR \-n DATE +creates a new event in NC_ENTRIES_FILE +.SH EXAMPLES +create an event due on date 4/15/23 with name "finish nc": $ nc -n 4/15/23 "finish nc" +.SH BUGS +Report all bugs on the issues page at https://git.everestlinux.org/EverestLinux/nc +.SH AUTHOR +Liam Waldron (liamwaldron@everestlinux.org)