From 756faa8e1a4f76d0e825a54cfba2e300761fb198 Mon Sep 17 00:00:00 2001 From: Pim Snel Date: Tue, 23 Mar 2021 16:24:56 +0100 Subject: [PATCH] Make documentation complete (#53) --- main.go | 6 ++++++ man/man1/smug.1 | 8 +++++++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/main.go b/main.go index ed01226..4209834 100644 --- a/main.go +++ b/main.go @@ -24,6 +24,12 @@ Options: -a, --attach %s -d, --debug %s +Commands: + list list available project sessions + start start project session + stop stop project session + print session configuration to stdout + Examples: $ smug list $ smug start blog diff --git a/man/man1/smug.1 b/man/man1/smug.1 index 0ffa548..87f970b 100644 --- a/man/man1/smug.1 +++ b/man/man1/smug.1 @@ -21,7 +21,7 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. .. -.TH smug 1 "Mar 2021" "smug 0.1.9" "smug - a session manager for tmux written in go" +.TH smug 1 "Mar 2021" "smug 0.2.0" "smug - a session manager for tmux written in go" .SH NAME smug - a session manager for tmux written in go @@ -64,6 +64,10 @@ Force switch client for a session. .B "stop []" Stop tmux project session +.TP +.B "print" +Print current session configuration as yaml to stdout + .SH EXAMPLES $ smug list .br @@ -78,6 +82,8 @@ $ smug start blog:win1,win2 $ smug stop blog .br $ smug start blog --attach +.br +$ smug print > ~/.config/smug/new_project.yml .SH AUTHOR Ivan Klymenchenko