Make a release

Login shells have a dash at the beginning of their first argument.

.clang-format

@@ -0,0 +1,14 @@
+BasedOnStyle: LLVM
+ColumnLimit: 80
+IndentWidth: 4
+TabWidth: 4
+UseTab: ForContinuationAndIndentation
+SpaceAfterCStyleCast: true
+SpaceBeforeParens: Always
+AlignAfterOpenBracket: DontAlign
+AlignEscapedNewlines: DontAlign
+AlignOperands: DontAlign
+AlignConsecutiveMacros: Consecutive
+BreakBeforeTernaryOperators: true
+SpacesBeforeTrailingComments: 2
+WhitespaceSensitiveMacros: ['XX', 'ACTIONS', 'LS']

CMakeLists.txt

@@ -1,47 +1,45 @@
 # target_compile_features has been introduced in that version
-cmake_minimum_required (VERSION 3.1.0)
-
-project (sdn CXX)
-set (version 0.1)
+cmake_minimum_required (VERSION 3.1...3.27)
+project (sdn VERSION 1.0 LANGUAGES CXX)
 
 if ("${CMAKE_CXX_COMPILER_ID}" MATCHES "GNU")
-	set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic")
-endif ()
-
-# Since we use a language with slow compilers, let's at least use a fast linker
-execute_process (COMMAND ${CMAKE_CXX_COMPILER} -fuse-ld=gold -Wl,--version
-	ERROR_QUIET OUTPUT_VARIABLE ld_version)
-if ("${ld_version}" MATCHES "GNU gold")
-	set (CMAKE_EXE_LINKER_FLAGS "-fuse-ld=gold ${CMAKE_EXE_LINKER_FLAGS}")
+	set (CMAKE_CXX_FLAGS
+		"${CMAKE_CXX_FLAGS} -Wall -Wextra -Wno-misleading-indentation -pedantic")
 endif ()
 
 find_package (PkgConfig REQUIRED)
-pkg_check_modules (NCURSESW QUIET ncursesw)
+pkg_check_modules (ACL libacl)
+pkg_check_modules (NCURSESW ncursesw)
+if (NOT NCURSESW_FOUND)
+	find_library (NCURSESW_LIBRARIES NAMES ncursesw)
+	find_path (NCURSESW_INCLUDE_DIRS ncurses.h PATH_SUFFIXES ncurses)
+endif ()
 
 add_executable (${PROJECT_NAME} ${PROJECT_NAME}.cpp)
 target_include_directories (${PROJECT_NAME} PUBLIC ${NCURSESW_INCLUDE_DIRS})
-target_link_libraries (${PROJECT_NAME} PUBLIC ${NCURSESW_LIBRARIES} acl)
+target_link_libraries (${PROJECT_NAME}
+	PUBLIC ${NCURSESW_LIBRARIES} ${ACL_LIBRARIES})
 target_compile_features (${PROJECT_NAME} PUBLIC cxx_std_14)
 target_compile_definitions (${PROJECT_NAME} PUBLIC
-	-DPROJECT_NAME=\"${PROJECT_NAME}\" -DPROJECT_VERSION=\"${version}\")
+	-DPROJECT_NAME=\"${PROJECT_NAME}\" -DPROJECT_VERSION=\"${PROJECT_VERSION}\")
 
 include (GNUInstallDirs)
 install (TARGETS ${PROJECT_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR})
 install (PROGRAMS ${PROJECT_NAME}-install DESTINATION ${CMAKE_INSTALL_BINDIR})
+install (FILES sdn.1 sdn-install.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1)
 install (FILES LICENSE DESTINATION ${CMAKE_INSTALL_DOCDIR})
 
 set (CPACK_PACKAGE_DESCRIPTION_SUMMARY "Directory navigator")
 set (CPACK_PACKAGE_VENDOR "Premysl Eric Janouch")
 set (CPACK_PACKAGE_CONTACT "Přemysl Eric Janouch <p@janouch.name>")
 set (CPACK_RESOURCE_FILE_LICENSE "${PROJECT_SOURCE_DIR}/LICENSE")
-set (CPACK_PACKAGE_VERSION ${version})
 set (CPACK_GENERATOR "TGZ;ZIP")
 set (CPACK_PACKAGE_FILE_NAME
-	"${PROJECT_NAME}-${version}-${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_PROCESSOR}")
-set (CPACK_PACKAGE_INSTALL_DIRECTORY "${PROJECT_NAME}-${version}")
+	"${PROJECT_NAME}-${PROJECT_VERSION}-${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_PROCESSOR}")
+set (CPACK_PACKAGE_INSTALL_DIRECTORY "${PROJECT_NAME}-${PROJECT_VERSION}")
 set (CPACK_SOURCE_GENERATOR "TGZ;ZIP")
 set (CPACK_SOURCE_IGNORE_FILES "/\\\\.git;/build;/CMakeLists.txt.user")
-set (CPACK_SOURCE_PACKAGE_FILE_NAME "${PROJECT_NAME}-${version}")
+set (CPACK_SOURCE_PACKAGE_FILE_NAME "${PROJECT_NAME}-${PROJECT_VERSION}")
 
 set (CPACK_SET_DESTDIR TRUE)
 include (CPack)

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2017 - 2020, Přemysl Eric Janouch <p@janouch.name>
+Copyright (c) 2017 - 2024, Přemysl Eric Janouch <p@janouch.name>
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted.

Makefile

@@ -1,12 +1,19 @@
+.POSIX:
 SHELL = /bin/sh
-CXXFLAGS = -g -std=c++14 -Wall -Wextra -pedantic -static-libstdc++
+CXXFLAGS = -g -std=c++14 -Wall -Wextra -Wno-misleading-indentation -pedantic
+CPPFLAGS = `sed -ne '/^project (\([^ )]*\) VERSION \([^ )]*\).*/ \
+	s//-DPROJECT_NAME="\1" -DPROJECT_VERSION="\2"/p' CMakeLists.txt`
 
-all: sdn
-%: %.cpp CMakeLists.txt
-	$(CXX) $(CXXFLAGS) $< -o $@ `pkg-config --libs --cflags ncursesw` -lacl \
-	`sed -ne 's/^project (\([^ )]*\).*/-DPROJECT_NAME="\1"/p' \
-	-e 's/^set (version \([^ )]*\).*/-DPROJECT_VERSION="\1"/p' CMakeLists.txt`
+sdn: sdn.cpp CMakeLists.txt
+	$(CXX) $(CXXFLAGS) $(CPPFLAGS) $< -o $@ \
+	-lacl `pkg-config --libs --cflags ncursesw`
+sdn-static: sdn.cpp CMakeLists.txt
+	$(CXX) $(CXXFLAGS) $(CPPFLAGS) $< -o $@ \
+	-static-libstdc++ \
+	-Wl,--start-group,-Bstatic \
+	-lacl `pkg-config --static --libs --cflags ncursesw` \
+	-Wl,--end-group,-Bdynamic
 clean:
-	rm -f sdn
+	rm -f sdn sdn-static
 
-.PHONY: all clean
+.PHONY: clean

NEWS

@@ -0,0 +1,4 @@
+1.0.0 (2024-12-21)
+
+ * Initial release
+

README.adoc

@@ -11,21 +11,26 @@ commands.  It enables you to:
    can be simply forwarded if it is to be edited.  What's more, it will always
    be obvious whether the navigator is running.
 
-The only supported platform is Linux.  I wanted to try a different, simpler
-approach here, and the end result is very friendly to tinkering.
+'sdn' runs on Linux and all BSD derivatives.  I wanted to try a different,
+simpler approach here, and the end result is very friendly to tinkering.
 
 image::sdn.png[align="center"]
 
+Packages
+--------
+Regular releases are sporadic.  git master should be stable enough.
+You can get a package with the latest development version using Arch Linux's
+https://aur.archlinux.org/packages/sdn-git[AUR],
+or as a https://git.janouch.name/p/nixexprs[Nix derivation].
+
 Building
 --------
 Build dependencies: CMake and/or make, a C++14 compiler, pkg-config +
-Runtime dependencies: ncursesw, libacl
+Runtime dependencies: ncursesw, libacl (on Linux)
 
 // Working around libasciidoc's missing support for escaping it like \++
-:doubleplus: ++
-
-Unfortunately most LLVM libc++ versions have a bug that crashes 'sdn' on start.
-Use GNU libstdc{doubleplus} if you're affected.
+Unfortunately most LLVM libc{plus}{plus} versions have a bug that crashes 'sdn'
+on start.  Use GNU libstdc{plus}{plus} if you're affected.
 
  $ git clone https://git.janouch.name/p/sdn.git
  $ mkdir sdn/build
@@ -45,8 +50,12 @@ Or you can try telling CMake to make a package for you.  For Debian it is:
 There is also a Makefile you can use to quickly build a binary to be copied
 into the PATH of any machine you want to have 'sdn' on.
 
+Configuration
+-------------
+For a slightly more technical explanation please refer to manual pages.
+
 Integration
------------
+~~~~~~~~~~~
 The package contains an installation script called 'sdn-install' which will bind
 'sdn' to Alt-o in your shell's initialisation file.  The supported shells are:
 
@@ -54,14 +63,11 @@ The package contains an installation script called 'sdn-install' which will bind
  - *bash*: minor issue: exiting the navigator confirms an empty prompt
  - *fish*: works well
  - *elvish*: version 0.14.1 and above, an unstable API is used, works well
-
++
 elvish is absolutely perverse.  And so is integrating 'sdn' into it because it
 already includes a custom file manager, bound to Ctrl-N (though I find the
 ranger-like interface confusing and resource-demanding).
 
-Configuration
--------------
-
 Colours
 ~~~~~~~
 Here is an example of a '~/.config/sdn/look' file; the format is similar to
@@ -86,7 +92,6 @@ To obtain more vifm-like controls, you may write the following to your
 ....
 normal h parent
 normal l choose
-normal ? help
 ....
 
 Helper programs

sdn-install

@@ -16,6 +16,9 @@ sdn-navigate () {
     # helpers after the terminal has been resized while running sdn
     command true
 
+    # Add to history, see https://www.zsh.org/mla/workers/2020/msg00633.html
+    fc -R =(print -- "$helper")
+
     /bin/sh -c "$helper" </dev/tty || break
   done
   # optionally: zle zle-line-init
@@ -51,6 +54,7 @@ sdn-navigate () {
       ((SDN_P=SDN_P+${#insert}+1))
     }
     [[ -z $helper ]] && break
+    history -s -- "$helper"
     /bin/sh -c "$helper" || break
   done
 }
@@ -60,9 +64,10 @@ sdn-restore () {
   unset SDN_L SDN_P
 }
 
-bind -x '"\200": sdn-navigate'
-bind -x '"\201": sdn-restore'
-bind '"\eo":"\200\C-m\201"'
+# These never occur in UTF-8: \300-\301 \365-\367 \370-\377
+bind -x '"\300": sdn-navigate'
+bind -x '"\301": sdn-restore'
+bind '"\eo": "\300\C-m\301"'
 EOF
 }
 
@@ -93,6 +98,7 @@ edit:insert:binding[Alt-o] = {
   local:posix = [cmd]{ /bin/sh -c $cmd </dev/tty >/dev/tty 2>&1 }
 
   # XXX: the -dot is not a stable API, and may hence break soon
+  # https://elv.sh/ref/builtin.html#do-not-use-functions-and-variables
   local:buffer = $edit:current-command
   local:cursor = (str:to-codepoints $buffer[0..$edit:-dot] | count)
   local:ns = (ns [&])
@@ -119,7 +125,7 @@ done
 
 # Figure out the shell to integrate with
 login=$(basename "$SHELL")
-actual=$(ps -p $$ -o ppid= | xargs ps -o comm= -p)
+actual=$(ps -p $$ -o ppid= | xargs ps -o comm= -p | sed 's/^-//')
 if [ -z "$shell" ]
 then
   if [ "$login" != "$actual" ]

sdn-install.1

@@ -0,0 +1,35 @@
+.Dd October 27, 2020
+.Dt SDN-INSTALL 1
+.Os Linux
+.Sh NAME
+.Nm sdn-install
+.Nd integrate sdn with the shell
+.Sh SYNOPSIS
+.Nm sdn-install
+.Op Fl s Ar shell
+.Op Fl p Ar - | rcpath
+.Sh DESCRIPTION
+.Nm
+integrates
+.Xr sdn 1
+with your shell, binding it to M-o.  If the navigator has already been
+integrated, it updates the snippet in-place.
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl p Ar -
+Merely print the integration snippet for the appropriate shell to the standard
+output, not changing anything.
+.It Fl p Ar rcpath
+Install the integration snippet into a different shell initialization file than
+the default one for your user.
+.It Fl s Ar shell
+If you want to integrate
+.Xr sdn 1
+with a different shell than the one you're running, use this option to specify
+it.
+.El
+.Sh REPORTING BUGS
+Use
+.Lk https://git.janouch.name/p/sdn
+to report bugs, request features, or submit pull requests.

sdn.1

@@ -0,0 +1,131 @@
+\" https://mandoc.bsd.lv/man/roff.7.html#Sentence_Spacing
+.Dd October 27, 2020
+.Dt SDN 1
+.Os Linux
+.Sh NAME
+.Nm sdn
+.Nd directory navigator
+.Sh SYNOPSIS
+.Nm sdn
+.Op Ar line Ar point
+.Nm sdn
+.Cm --version
+.Sh DESCRIPTION
+.Nm
+is a simple directory navigator that you can launch while editing shell
+commands.
+Use the
+.Xr sdn-install 1
+script to integrate it with your shell, then invoke it at any time with M-o.
+.Pp
+Press F1 to get a list of active key bindings and their assigned actions,
+grouped by their contexts.
+.Pp
+Program arguments are only used by integration snippets to forward the parent
+shell's command line.
+The
+.Ar point
+is given in terms of characters.
+.Sh OPTIONS
+While some behaviour can be toggled from within the program, some can only be
+changed by modifying configuration files manually.
+.Pp
+The files follow a simple syntax derived from the Bourne shell: each option is
+on its own line, with words separated by linear whitespace.
+Comments start with a hash (#) and continue until the end of the line.
+All special characters may be quoted using either a backslash or single-quoted
+strings.
+.Pp
+The options and the default key bindings controlling them are as follows:
+.Bl -tag
+.It full-view Em bool No (t)
+If non-zero, the equivalent format to
+.Ql ls -l
+is used to display directory contents rather than simply listing the filenames.
+.It gravity Em bool
+If non-zero, all entries stick to the bottom of the screen, i.e., all empty
+space is at the top.
+.It reverse-sort Em bool No (R)
+If non-zero, the order of entries is reversed.
+.It show-hidden Em bool No (M-.)
+If non-zero, filenames beginning with a full stop are shown.
+.It ext-helpers Em bool
+If non-zero, viewers and editors are launched from the parent shell.
+This way you can suspend them and use job control features of the shell.
+However it also enforces any pending change to the shell's working directory.
+.It sort-column Em number No (< >)
+The zero-based index of the
+.Ql full-view
+column that entries are ordered by.
+.El
+.Sh ENVIRONMENT
+.Bl -tag -width 15n
+.It Ev LS_COLORS
+Used to retrieve filename colours.
+The format is described in
+.Xr dir_colors 5
+and you can use the
+.Xr dircolors 1
+utility to initialize this variable.
+.It Ev PAGER
+The viewer program to be launched by the F3 key binding as well as to show
+the internal help message.
+If none is set, it defaults to
+.Xr less 1 .
+.It Ev VISUAL , Ev EDITOR
+The editor program to be launched by the F4 key binding.
+If neither variable is set, it defaults to
+.Xr vi 1 .
+.El
+.Sh FILES
+.Bl -tag -width 25n -compact
+.It Pa ~/.config/sdn/config
+Program configuration and navigation state, initialized or overwritten on exit.
+.It Pa ~/.config/sdn/bindings
+Custom key binding overrides.
+.It Pa ~/.config/sdn/look
+Redefine terminal attributes for UI elements.
+.El
+.Sh EXAMPLES
+.Ss Pa bindings
+Key names or combinations follow the Emacs syntax for Control and Meta prefixes
+and
+.Xr terminfo 5
+names are used for special keys.
+To obtain more vifm-like controls and Windows-like quit abilities:
+.Bd -literal -offset indent
+normal h parent
+normal l choose
+normal M-f4 quit
+.Ed
+.Pp
+Midnight Commander binds the same traversal actions to sequences normally
+unknown to ncurses, due to them being missing from terminfo.
+You'll need to define them manually to match your terminal.
+For rxvt, that would be:
+.Bd -literal -offset indent
+define C-ppage ^[[5^
+define C-npage ^[[6^
+normal C-ppage parent
+normal C-npage choose
+.Ed
+.Pp
+Escape characters must be inserted verbatim, e.g., by pressing C-v ESC in vi,
+or C-q ESC in Emacs.
+.Ss Pa look
+Terminal attributes are accepted in a format similar to that of
+.Xr git-config 1 ,
+only named colours aren't supported.
+For a black-on-white terminal supporting 256 colours, a theme such as the
+following may work:
+.Bd -literal -offset indent
+cursor 231 202
+bar 16 255 ul
+cwd bold
+input
+cmdline 145
+.Ed
+.Sh REPORTING BUGS
+Use
+.Lk https://git.janouch.name/p/sdn
+to report bugs, request features, or submit pull requests.