commit 7683a06cbf28e73333742a8b3621b984b0867f95 parent fcae73f44231a683aae43b94cc076593bf8f06b4 Author: sin <sin@2f30.org> Date: Fri, 15 Nov 2013 14:04:15 +0000 Add manpage Diffstat:
| M | Makefile | | | 5 | +++++ |
| M | config.mk | | | 1 | + |
| A | rs.1 | | | 28 | ++++++++++++++++++++++++++++ |
3 files changed, 34 insertions(+), 0 deletions(-)
diff --git a/Makefile b/Makefile @@ -46,10 +46,15 @@ install: all @echo installing executable to $(DESTDIR)$(PREFIX)/bin @cp -f $(BIN) $(DESTDIR)$(PREFIX)/bin @cd $(DESTDIR)$(PREFIX)/bin && chmod 755 $(BIN) + @mkdir -p $(DESTDIR)$(MANPREFIX)/man1 + @echo installing manpage to $(DESTDIR)$(MANPREFIX)/man1 + @cp -f rs.1 $(DESTDIR)$(MANPREFIX)/man1 uninstall: @echo removing executable from $(DESTDIR)$(PREFIX)/bin @cd $(DESTDIR)$(PREFIX)/bin && rm -f $(BIN) + @echo removing manpage from $(DESTDIR)$(MANPREFIX)/man1 + @cd $(DESTDIR)$(MANPREFIX)/man1 && rm -f rs.1 clean: @echo cleaning diff --git a/config.mk b/config.mk @@ -3,6 +3,7 @@ VERSION = 0.1 # paths PREFIX = /usr/local +MANPREFIX = $(PREFIX)/share/man CC = cc LD = $(CC) diff --git a/rs.1 b/rs.1 @@ -0,0 +1,28 @@ +.TH RS 1 +.SH NAME +rs \- FTDI serial communication program +.SH SYNOPSIS +.B rs [ \-l ] [ \-b baurate] [ \-v vendor ] [ \-p product] [ \-d device ] +.SH DESCRIPTION +.B rs +is an FTDI based serial communication program. You need to be root to run it +or be part of the relevant group on your system. If no arguments are provided +it defaults to a baudrate of 115200 and a vendor ID of 0x0403 and a product ID +of 0x6001. +.SH OPTIONS +.TP +.B \-l +List FTDI devices +.TP +.B \-b +Set the baudrate +.TP +.B \-v +Set the vendor ID +.TP +.B \-p +Set the product ID +.TP +.B \-d +Set the device that you want to use. List the devices first to obtain +the device ID.