From 26fe75a2c7179705a69b75c4c8dfc921f8d80ebe Mon Sep 17 00:00:00 2001 From: mithe24 Date: Tue, 28 Oct 2025 11:47:45 +0100 Subject: Updated man page to reflect v1.0.0 program --- src/docs/sorter.1 | 37 ++++++++++++++++++++++++++----------- 1 file changed, 26 insertions(+), 11 deletions(-) (limited to 'src/docs/sorter.1') diff --git a/src/docs/sorter.1 b/src/docs/sorter.1 index 823872e..7b81e75 100644 --- a/src/docs/sorter.1 +++ b/src/docs/sorter.1 @@ -1,23 +1,38 @@ -.\" Manpage for myprog +.\" Manpage for sorter .TH SORTER 1 "October 2025" "1.0" "Sorter Manual" .SH NAME sorter \- a simple program for sorting lists of coordinates .SH SYNOPSIS .B sorter -[OPTION] [file...] +[\-a ALGORITHM] [file] .SH DESCRIPTION -A command-line sorting utility for sorting lists of coordinates. +A command-line utility for sorting lists of coordinates. +.PP +The +.B sorter +program reads a list of coordinates from a file and sorts them using the specified algorithm. .SH OPTIONS .TP -\-h, \--help -Show help message and exit. +.B \-a +Specifies the sorting algorithm to use. Valid options are: +.RS +.TP +.B qsort +Sorts the list of coordinates using a quicksort algorithm. .TP -\-r, \--reverse -Sorts list of coordinates in descending order +.B isort +Sorts the list of coordinates using an insertion sort algorithm. +.RE .TP -\ -Input file(s) to process. +.I file +Input file to process. .SH EXAMPLES -sorter file.txt +Sort a file using quicksort: +.PP +.B sorter \-a qsort file.tsv +.PP +Sort a file using insertion sort: +.PP +.B sorter \-a isort file.tsv .SH SEE ALSO -sort(1) +.B sort(1) -- cgit v1.2.3-70-g09d2