1.10: added man

Author: zvezdochiot

Makefile

@@ -1,10 +1,15 @@
 PROJECT := torrentcheck
 CFLAGS := -O
+OBJS := src/torrentcheck.o src/sha1.o
+RM := rm -f
 
 all: $(PROJECT)
 
-clean:
-	rm *.o $(PROJECT)
+$(PROJECT): $(OBJS)
+	$(CC) $(CFLAGS) $^ -o $@
+
+%.c: %.o
+	$(CC) -c $(CFLAGS) $^ -o $@
 
-$(PROJECT): torrentcheck.o sha1.o
-	$(CC) -o $@ $^ $(CFLAGS)
+clean:
+	$(RM) $(OBJS) $(PROJECT)

man/man1/torrentcheck.1

@@ -0,0 +1,45 @@
+.TH torrentcheck "1" "1.10" "07 Jan 2023" "User Manual"
+
+.SH NAME
+torrentcheck
+
+.SH DESCRIPTION
+Catalog a \fI.torrent\fR file and optionally verify content hashes
+
+.SH SYNOPSIS
+torrentcheck torrent-file [-p content-path] [-n] [-h] [-c] [-d]
+
+.SH OPTIONS
+.TP
+-p content-path
+path of content data
+.TP
+-n
+suppresses progress count
+.TP
+-h
+shows all hash values
+.TP
+-c or -d
+uses comma or dot formatted byte counts.
+
+Returns 0 if successful, nonzero return code if errors found.
+
+.TP
+-sha1 [optional hash]
+acts as a simple SHA1 filter
+
+If -sha1 is followed by a hex hash, the return code will be zero
+on match and nonzero otherwise.
+
+.SH EXAMPLE
+torrentcheck my.torrent
+ 
+.SH COPYRIGHT
+Mike Ingle <[email protected]>
+
+.SH SEE ALSO
+torreadwrite(1), ctorrent(1), aria2c(1)
+
+.SH CONTACTS
+Website: https://github.com/ximellon/torrentcheck

sha1.c src/sha1.csha1.c renamed to src/sha1.c

@@ -529,16 +529,19 @@ int main(int argc,char* argv[])
     if (torrentFile == NULL)
     {
         printf("torrentcheck - catalog a .torrent file and optionally verify content hashes\n");
-        printf("Usage: torrentcheck -t torrent-file [-p content-path] [-n] [-h] [-c] [-d]\n");
-        printf("Options: -n suppresses progress count, -h shows all hash values,\n");
-        printf("         -c or -d uses comma or dot formatted byte counts.\n");
+        printf("Usage: torrentcheck torrent-file [-p content-path] [-n] [-h] [-c] [-d]\n");
+        printf("Options:\n");
+        printf("\t-n suppresses progress count,\n");
+        printf("\t-h shows all hash values,\n");
+        printf("\t-c or -d uses comma or dot formatted byte counts.\n");
         printf("Returns 0 if successful, nonzero return code if errors found.\n");
         printf("\n");
-        printf("Option: -sha1 [optional hash] acts as a simple SHA1 filter.\n");
+        printf("Option:\n");
+        printf("\t-sha1 [optional hash] acts as a simple SHA1 filter.\n");
         printf("If -sha1 is followed by a hex hash, the return code will be zero\n");
         printf("on match and nonzero otherwise.\n");
         printf("\n");
-        printf("V1.00 2010-12-01 Mike Ingle <[email protected]>\n");
+        printf("V1.10 2023-01-07 Mike Ingle <[email protected]>\n");
         return 3;
     }