Skip to content

Commit

Permalink
project: keep manpage files in project folder
Browse files Browse the repository at this point in the history
  • Loading branch information
patrick330602 committed Jan 9, 2019
1 parent cc31df6 commit ab0ce19
Show file tree
Hide file tree
Showing 8 changed files with 204 additions and 5 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
out
target
gendocs
4 changes: 1 addition & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,7 @@ link:
cp src/etc/* /usr/share/wslu

install:
for file in $(OUTFILES); do \
cp $(CURPATH)/$$file /usr/bin/`basename $$file`; \
done
install -m755 out/* /usr/bin
[ -d /usr/share/wslu ] || mkdir -p /usr/share/wslu
cp src/etc/* /usr/share/wslu

Expand Down
28 changes: 28 additions & 0 deletions docs/wslfetch.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WSLFETCH" "1" "January 2019" "Patrick Wu" "WSLFETCH"
.


.
.SH "NAME"
wslfetch \- Component of Windows 10 Linux Subsystem Utility
.
.SH "Synopsis"
\fBwslfetch (\-h|\-v|\-s|\-l)\fR
.
.SH "Description"
This is a WSL Screenshot Information Tool to print information in a elegant way\.
.
.SH "COMMANDS"
\fB\-h, \-\-help\fR \- print a simple help
.
.P
\fB\-v, \-\-version\fR \- print current version
.
.P
\fB\-l, \-\-line\fR \- print a separate line before and after
.
.P
\fB\-s, \-\-splash\fR \- use wslfetch as splash when startup; add \'wslfetch \-\-splash\' to the end of the rc file
49 changes: 49 additions & 0 deletions docs/wslsys.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WSLSYS" "1" "January 2019" "Patrick Wu" "WSLSYS"
.

\fBwslsys\fR
.
.SH "NAME"
wslsys \- Component of Windows 10 Linux Subsystem Utility
.
.SH "Synopsis"
\fBwslsys (\-h|\-v|\-S|\-U|\-b|\-B|\-fB|\-R|\-K|\-P) \-s\fR
.
.SH "Description"
This is a WSL system information printer to print out some basic system information\.
.
.SH "Commands"
Default will print out the overall system information\. more options are following(add \-s flag to print only value):
.
.P
\fB\-h, \-\-help\fR \- print a simple help
.
.P
\fB\-v, \-\-version\fR \- print current version
.
.P
\fB\-S, \-\-shell\fR \- print used shell
.
.P
\fB\-U, \-\-uptime\fR \- print current uptime
.
.P
\fB\-b, \-\-branch\fR \- print windows build information
.
.P
\fB\-B, \-\-build\fR \- print Windows build information
.
.P
\fB\-fB, \-\-full\-build\fR \- print full Windows build information
.
.P
\fB\-K, \-\-kernel\fR \- print WSL kernel info
.
.P
\fB\-R, \-\-release\fR \- print WSL system release info
.
.P
\fB\-P, \-\-package\fR \- print total installed packages
72 changes: 72 additions & 0 deletions docs/wslupath.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WSLUPATH" "1" "January 2019" "Patrick Wu" "WSLUPATH"
.

\fBwslupath\fR
.
.SH "NAME"
wslupath \- Component of Windows 10 Linux Subsystem Utility
.
.SH "Synopsis"
\fBwslupath (\-w|\-d|\-u|\-m|\-r) [\-D|\-A|\-T|\-S|\-W|\-s|\-su|\-H|\-P|\.\.\.NAME\.\.\.]\fR
.
.P
\fBwslupath (\-h|\-v|\-R)\fR
.
.SH "Description"
This is a WSL Windows path Converter that can convert Windows path to other styles of path\.
.
.SH "Commands"
.
.SS "Output Type Options"
\fB\-w, \-\-windows\fR \- print Windows form of path(C:\eWindows\eSystem32)
.
.P
\fB\-d, \-\-windows\-double\-slash\fR \- print Windows form of path with double backslash(C:\e\eWindows\e\eSystem32)
.
.P
\fB\-u, \-\-unix\fR \- print Unix form of path(/mnt/c/Windows/System32)
.
.P
\fB\-m, \-\-mixed\fR \- print Windows form of path(C:WindowsSystem32)
.
.P
\fB\-r, \-\-reg\-data\fR \- use the registry data to print path[wslpath \-R to know more]
.
.SS "System Path"
\fB\-D, \-\-desktop\fR \- print desktop path and exit
.
.P
\fB\-A, \-\-appdata\fR \- print AppData path(%APPDATA%) and exit
.
.P
\fB\-T, \-\-temp\fR \- print temp path(%TMP%) and exit
.
.P
\fB\-S, \-\-sysdir\fR \- print system path and exit
.
.P
\fB\-W, \-\-windir\fR \- print Windows path and exit
.
.P
\fB\-s, \-\-start\-menu\fR \- print Start Menu path and exit
.
.P
\fB\-su, \-\-startup\fR \- print Startup path and exit
.
.P
\fB\-H, \-\-home\fR \- print user home path(%HOMEPATH%) and exit
.
.P
\fB\-P, \-\-program\-files\fR \- print Program Files path(%ProgramFiles%) and exit
.
.SS "Other Options"
\fB\-h, \-\-help\fR \- print a simple help
.
.P
\fB\-v, \-\-version\fR \- print current version
.
.P
\fB\-R, \-\-avail\-reg\fR \- print available registery input
25 changes: 25 additions & 0 deletions docs/wslusc.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WSLUSC" "1" "January 2019" "Patrick Wu" "WSLUSC"
.

\fBwslusc\fR
.
.SH "NAME"
wslusc \- Component of Windows 10 Linux Subsystem Utility
.
.SH "Synopsis"
\fBwslusc (\-g|\-h|\-v) \.\.NAME\.\.\.\fR
.
.SH "Description"
This is a WSL shortcut creator to create shortcut on Windows Desktop
.
.SH "Commands"
\fB\-h, \-\-help\fR \- print a simple help
.
.P
\fB\-v, \-\-version\fR \- print current version
.
.P
\fB\-g, \-\-gui\fR \- create a shortcut that links to a GUI application
28 changes: 28 additions & 0 deletions docs/wslview.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WSLVIEW" "1" "January 2019" "Patrick Wu" "WSLVIEW"
.

\fBwslview\fR
.
.SH "NAME"
wslview \- Component of Windows 10 Linux Subsystem Utility
.
.SH "Synopsis"
\fBwslview (\-u|\-r|\-h|\-v) \.\.\.LINK\.\.\.\fR
.
.SH "Description"
This is a fake WSL browser that can help you open link in default Windows browser\.
.
.SH "COMMANDS"
\fB\-h, \-\-help\fR \- print a simple help
.
.P
\fB\-v, \-\-version\fR \- print current version
.
.P
\fB\-u, \-\-unregister\fR \- remove \fBwslview\fR as the default WSL web browser\.
.
.P
\fB\-r, \-\-register\fR \- register \fBwslview\fR as the default WSL web browser\.
2 changes: 1 addition & 1 deletion extras/scripts/builder-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
git clone https://github.com/wslutilities/wslu.wiki.git

OUTPATH="../../gendocs"
SOURCES=(wslfetch wslsys wslupath wslusc wslview)
SOURCES=(wslfetch wslsys wslupath wslusc wslview wslvar)
BUILD_TIME="$(date +%Y-%m-%d)"

[ -d $OUTPATH ] || mkdir $OUTPATH
Expand Down

0 comments on commit ab0ce19

Please sign in to comment.