diff options
| author | mithe24 <mithe24@student.sdu.dk> | 2025-10-28 11:47:45 +0100 |
|---|---|---|
| committer | mithe24 <mithe24@student.sdu.dk> | 2025-10-29 13:49:57 +0100 |
| commit | 26fe75a2c7179705a69b75c4c8dfc921f8d80ebe (patch) | |
| tree | c424fd48dbe4d70576d3b54b6ea80f51686f7b50 /src/docs/sorter.1 | |
| parent | b68fc9c777dd21d6f9b030c4f3581eda0f5fa7e3 (diff) | |
| download | sorter-26fe75a2c7179705a69b75c4c8dfc921f8d80ebe.tar.gz sorter-26fe75a2c7179705a69b75c4c8dfc921f8d80ebe.zip | |
Updated man page to reflect v1.0.0 program
Diffstat (limited to 'src/docs/sorter.1')
| -rw-r--r-- | src/docs/sorter.1 | 37 |
1 files changed, 26 insertions, 11 deletions
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 -\<file\> -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) |