From 03d827e2fbc409ef97829f25b8eeca5204f81a3c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?John=20Ankarstr=C3=B6m?= <john@ankarstrom.se>
Date: Mon, 12 Jul 2021 13:24:49 +0200
Subject: Re-organize files

---
 doc/ord.1 | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 doc/ord.1

(limited to 'doc/ord.1')

diff --git a/doc/ord.1 b/doc/ord.1
new file mode 100644
index 0000000..9ab54a5
--- /dev/null
+++ b/doc/ord.1
@@ -0,0 +1,51 @@
+.Dd $Mdocdate$
+.Dt ord 1
+.Os
+.
+.Sh NAME
+.Nm ord
+.Nd re-order files with numeric indices
+.
+.Sh SYNOPSIS
+.Nm
+.Op Fl n Ar "number width"
+.Op Fl s Ar separator
+.Ar file ...
+.
+.Sh DESCIPTION
+.Pp
+.Nm
+is a convenient utility for re-ordering numerically indexed files, i.e. files with names beginning with
+.Ql 01.\  ,
+.Ql 02.\ 
+and so forth.
+Among other things, it is useful for managing disk-based playlists.
+
+Given any number of files as arguments,
+.Nm
+will open a temporary text file in your
+.Ev EDITOR ,
+in which you can re-order the files by re-ordering lines.
+Save the file and exit the text editor to change the names of the files to reflect the new order.
+
+The
+.Fl n
+and
+.Fl s
+control the format of the numeric indices expected and created by
+.Nm .
+Their respective default values are 2 and
+.Ql .\  .
+
+Note that
+.Fl n
+and
+.Fl s
+cannot be used to change the format of existing numeric indices.
+Such functionality is not provided by
+.Nm .
+.Sh AUTHORS
+.Pp
+.Nm
+is written by John Ankarström
+.Aq Mt john (at) ankarstrom.se .
-- 
cgit v1.2.3