From 5589490fe28b03f138082b631872933fd5572790 Mon Sep 17 00:00:00 2001 From: Valerie Wolfe Date: Mon, 15 Jul 2024 14:00:02 -0400 Subject: [PATCH] man: created 'hug' manual --- README.md | 2 +- man/hug.1 | 25 +++++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 man/hug.1 diff --git a/README.md b/README.md index b8df0d8..490d8ee 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ shells. The utility runs in WSL, and companion scripts run in Windows. ## `hug` -A wrapper for turning binary-output text into normal text. +A barebones command wrapper for turning binary-output text into normal text. ## `mkwin` diff --git a/man/hug.1 b/man/hug.1 new file mode 100644 index 0000000..c840216 --- /dev/null +++ b/man/hug.1 @@ -0,0 +1,25 @@ +.Dd $Mdocdate$ +.Dt HUG 1 +.Os WSL +.Sh NAME +.Nm hug +.Nd wraps processes and converts binary output to text +.Sh SYNOPSIS +.Nm +.Ar target +.Op Ar args... +.Sh DESCRIPTION +The +.Nm +utility runs a process and emits bytes from standard output to text. +.Sh EXAMPLES +WSL's help text is output as binary content, preventing piping to utilities like +.Xr less 1 +or +.Xr bat 1 : +.Pp +.Dl $ hug wsl --help | less +.Pp +.Sh Authors +.An -nosplit +.An Valerie Wolfe Aq Mt sleeplessval@gmail.com