Skip to content

Commit

Permalink
📝 man page
Browse files Browse the repository at this point in the history
close #34

Also install README to doc directory.
  • Loading branch information
weakish committed Jan 23, 2024
1 parent c3e0faa commit 5a704f7
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
man/*.gz
13 changes: 12 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,21 @@ NAME=gister

PREFIX?=/usr/local
BINDIR=${PREFIX}/bin
MANDIR=${PREFIX}/man/man1
DOCDIR=${PREFIX}/share/doc/${NAME}

install: ${NAME}
install: man/${NAME}.1.gz
@mkdir -p ${BINDIR}
@install -c -m 755 bin/${NAME} ${BINDIR}/${NAME}
@mkdir -p ${MANDIR}
@install -c -m 644 man/${NAME}.1.gz ${MANDIR}/${NAME}.1.gz
@mkdir -p ${DOCDIR}
@install -c -m 644 README.md ${DOCDIR}/README.md

man/${NAME}.1.gz:
@gzip -k man/${NAME}.1

uninstall:
@rm -f ${BINDIR}/${NAME}
@rm -f ${MANDIR}/${NAME}.1.gz
@rm -rf ${DOCDIR}
34 changes: 34 additions & 0 deletions man/gister.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
.Dd January 22, 2024
.Dt GISTER 1
.Os
.Sh NAME
.Nm gister
.Nd "sync GitHub gists to local machine"
.Sh SYNOPSIS
.Nm
.Fl h
.Nm
.Cm init
.Nm
.Cm sync
.Nm
.Cm search
.Ar pattern
.Nm
.Cm export
.Ar gist_id
.Ar sub_directory_name
.Ar branch_name
.Sh DESCRIPTION
Run
.Nm
.Fl h
for usage description.
.Sh BUGS
.Nm
cannot sync more than ten million gists.
To lift the limit, you need to modify the source code of
.Nm .
.Pp
If you find other bugs, please report them at
.Lk https://github.com/weakish/gister/issues

0 comments on commit 5a704f7

Please sign in to comment.