writedoc.1


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

.\" Automatically generated by Pandoc 3.1.12.1
.\"
.TH "" "" "" "" ""
.SH writedoc
A simple POSIX compliant package to make it easier and faster to create markdown files.
.SS Usage
\f[CR]writedoc <options> <filename>\f[R]
.PP
The current options are: \- \-d Define a custom directory to create the
new file \- \-t Define a custom file type for the new file \- \-c Use
when you want to change the default value(s) for the directory and/or
file type make sure to use it alongside \-d or \-t FILENAME is not
required when using this flag \- \-r Reset all values back to their
defaults FILENAME is not required when using this flag \- \-p Use the
default directory PLUS another folder
.PP
The default value for the directory is \f[CR]./Documents/\f[R] The
default value for the file type is \f[CR].md\f[R]
.SS Examples
If I were to create a file called \f[CR]work\f[R] in the default
directory with the default file type, the resulting command would be:
.PP
\f[CR]writedoc work\f[R]
.PP
If I wanted to create a file called \f[CR]work\f[R] with the directory
\f[CR]\[ti]/ImportantFiles/\f[R] with the file type\f[CR].csv\f[R], the
resulting command would be:
.PP
\f[CR]writedoc \-d \[ti]/ImportantFiles \-t .csv work\f[R]
.PP
If I wanted to change the default value for the directory to be
\f[CR]\[ti]/ImportantFiles/\f[R] and the default value for the file type
to be \f[CR].csv\f[R], the resulting command would be:
.PP
\f[CR]writedoc \-c \-d \[ti]/ImportantFiles \-t .csv\f[R]
.PP
If I wanted to reset the default values, the resulting command would be:
.PP
\f[CR]writedoc \-r\f[R]
.PP
If I wanted to created a file called \f[CR]work\f[R] in the default
directory plus a folder called \f[CR]Important\f[R] (i.e the directory
would be \f[CR]\[ti]/DEFAULT/Important/\f[R]), the resulting command
would be:
.PP
\f[CR]writedoc \-p Important work\f[R]
.SS Installation
.SS Automatic Install
writedoc is availiable on the AUR (Arch Linux User Repository)
.PP
You can use your preferred AUR helper to intall writedoc:
.PP
\f[CR]yay \-S writedoc\f[R]
.SS Manual Install
Make sure you have the required prerequisites installed:
\f[CR]base\-devel\f[R] and \f[CR]git\f[R]
.PP
Clone the AUR repo:
.PP
\f[CR]git clone https://aur.archlinux.org/cgit/aur.git/d/plain/?h=writedoc cd writedoc\f[R]
.PP
Build the package: \f[CR]makepkg \-si\f[R]
.PP
This is very much a work in progress and many more improvements are to
come!