~doyle/rgit.git

author	holly sparkles <sparkles@holly.sh>	2024-01-11 21:24:18.0 +01:00:00
committer	Jordan Doyle <jordan@doyle.la>	2024-01-13 13:18:39.0 +00:00:00
commit	9d1b51c3e3fdb1edcaffec4207664a063d51d8ec [patch]
tree	02e0c1fe26c170cc0b0661dbba28975d5d4994d3
parent	7f16712aea03c5aec3152ab846493429b05c2a2c
download	9d1b51c3e3fdb1edcaffec4207664a063d51d8ec.tar.gz

Add man page template for pandoc

Signed-off-by: Jordan Doyle <jordan@doyle.la>

Diff

 doc/man/rgit.1.md | 105 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 105 insertions(+)

diff --git a/doc/man/rgit.1.md b/doc/man/rgit.1.md
new file mode 100644
index 0000000..29eca92 100644
--- /dev/null
+++ a/doc/man/rgit.1.md
@@ -1,0 +1,105 @@
% RGIT(1) version 0.1.2 | User Commands
%
% 11 January 2024

NAME
====

rgit - a gitweb interface written in rust

SYNOPSIS
========

| **rgit** \[*OPTIONS*] **\--db-store** *path* *bind_address* *scan_path*

DESCRIPTION
===========

A gitweb/cgit-like interface for the modern age. Written in Rust using Axum, git2, Askama, and Sled.  
  
_bind_address_ 

:   Specifies the network address and port to serve the application on.
(Required)  

    Example:


    :   _0.0.0.0:3333_ (localhost, port 3333 on IPv4)


        _[::]:3333_ (localhost, port 3333 on IPv6)  


_scan_path_ 

:   Specifies the root directory where git repositories reside. Scans recursively.
(Required)  
  
    For information about bare git repositories, see the manual for **git-init**(1).  


    Example:


    :   _/srv/git_


        _$HOME/git_



OPTIONS
=======

**-d** _path_, **\--db-store** _path_

:   Path to a directory in which the Sled database should be stored, will be created if it doesn't already exist.  

    The Sled database is very quick to generate, so this can be pointed to temporary storage. (Required)


    Example:


    :   **\--db-store** _/tmp/rgit-cache.db_


**\--refresh-interval** _interval_

:   Configures the metadata refresh interval. This parameter accepts human-readable time formats.

    Default: _5m_


    Example:


    :   **\--refresh-interval** _60s_ (refresh every 60 seconds)


        **\--refresh-interval** _never_ (refresh only on server start)


    Documentation:


    :    https://docs.rs/humantime/latest/humantime/


EXAMPLES
========

```

$ rgit -d /tmp/rgit-cache.db [::]:3333 /srv/git
$ rgit --db-store /tmp/rgit-cache.db 0.0.0.0:3333 /srv/git
$ rgit -d /tmp/rgit-cache.db [::]:3333 /srv/git --refresh-interval 12h

```


BUGS
====

https://github.com/w4/rgit/issues

AUTHORS
=======

Jordan Doyle \<jordan@doyle.la>

REPOSITORY
==========

https://git.inept.dev/~doyle/rgit.git

https://github.com/w4/rgit

SEE ALSO
========

**git**(1),
**git-init**(1)