Merge pull request #24 from wezm/man

Add man page

doc/convert-to-man

@@ -0,0 +1,27 @@
+#!/bin/sh -e
+
+# The MIT License (MIT)
+
+# Copyright (c) 2015 Andrew Gallant
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# 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.
+
+pandoc -s -t man fac.1.md -o fac.1
+sed -i.bak 's/\.TH.*/.TH "fac" "1"/g' fac.1
+rm -f fac.1.bak # BSD `sed` requires the creation of a back-up file

doc/fac.1

@@ -0,0 +1,77 @@
+.\" Automatically generated by Pandoc 2.0.2
+.\"
+.TH "fac" "1"
+.hy
+.SH NAME
+.PP
+fac \- tool for resolving git merge conflicts
+.SH SYNOPSIS
+.PP
+fac
+.SH DESCRIPTION
+.PP
+Fix All Conflicts (fac) aims to make resolving git(1) merge conflicts
+easier.
+It provides an ncurses\-based based terminal user interface to resolve
+conflicts interactively.
+.PP
+The UI is split into three panes.
+Two show the versions of content in conflict.
+The third, a sidebar show actions that can be taken to resolve the
+conflict.
+.SH USAGE
+.PP
+fac operates much like \f[C]git\ add\ \-p\f[].
+It has a prompt for input at the bottom of the screen where the various
+commands are entered.
+.PP
+The commands have been preset to the following specifications:
+.PP
+\f[B]w\f[] \- show more lines up
+.PD 0
+.P
+.PD
+\f[B]s\f[] \- show more lines down
+.PD 0
+.P
+.PD
+\f[B]a\f[] \- use local version
+.PD 0
+.P
+.PD
+\f[B]d\f[] \- use incoming version
+.PP
+\f[B]j\f[] \- scroll down
+.PD 0
+.P
+.PD
+\f[B]k\f[] \- scroll up
+.PP
+\f[B]v\f[] \- [v]iew orientation
+.PD 0
+.P
+.PD
+\f[B]n\f[] \- [n]ext conflict
+.PD 0
+.P
+.PD
+\f[B]p\f[] \- [p]revious conflict
+.PP
+\f[B]h\f[] | \f[B]?\f[] \- [h]elp
+.PD 0
+.P
+.PD
+\f[B]q\f[] | \f[B]Ctrl+c\f[] \- [q]uit
+.PP
+The movement controls have been derived from both the world of gamers
+(WASD) and vi(1) users (HJKL).
+.SH BUGS
+.PP
+fac does not currently support diff3 merge conflict output.
+.SH NOTES
+.IP "1." 3
+Home page and source code
+.PD 0
+.P
+.PD
+https://github.com/mkchoi212/fac

doc/fac.1.md

@@ -0,0 +1,50 @@
+# NAME
+
+fac - tool for resolving git merge conflicts
+
+# SYNOPSIS
+
+fac
+
+# DESCRIPTION
+
+Fix All Conflicts (fac) aims to make resolving git(1) merge conflicts easier.
+It provides an ncurses-based based terminal user interface to resolve conflicts
+interactively.
+
+The UI is split into three panes. Two show the versions of content in conflict.
+The third, a sidebar show actions that can be taken to resolve the conflict.
+
+# USAGE
+
+fac operates much like `git add -p`. It has a prompt for input at the bottom of
+the screen where the various commands are entered.
+
+The commands have been preset to the following specifications:
+
+**w** - show more lines up  
+**s** - show more lines down  
+**a** - use local version  
+**d** - use incoming version
+
+**j** - scroll down  
+**k** - scroll up
+
+**v** - [v]iew orientation  
+**n** - [n]ext conflict  
+**p** - [p]revious conflict
+
+**h** | **?** - [h]elp  
+**q** | **Ctrl+c** - [q]uit
+
+The movement controls have been derived from both the world of gamers (WASD)
+and vi(1) users (HJKL).
+
+# BUGS
+
+fac does not currently support diff3 merge conflict output.
+
+# NOTES
+
+1. Home page and source code  
+   https://github.com/mkchoi212/fac