mirror of
				https://github.com/NotAShelf/nvf.git
				synced 2025-10-31 02:52:37 +00:00 
			
		
		
		
	docs: improve manpages; mention helpful utilities
This commit is contained in:
		
					parent
					
						
							
								3a6d2f7294
							
						
					
				
			
			
				commit
				
					
						a5b7b17947
					
				
			
		
					 2 changed files with 39 additions and 17 deletions
				
			
		|  | @ -1,13 +1,16 @@ | ||||||
| .TH "nvf" "5" "01/01/1980" "nvf" | .TH "nvf" "5" "January 1, 1980" "nvf" | ||||||
| .\" disable hyphenation | .\" disable hyphenation | ||||||
| .nh | .nh | ||||||
| .\" disable justification (adjust text to left margin only) | .\" disable justification (adjust text to left margin only) | ||||||
| .ad l | .ad l | ||||||
| .\" enable line breaks after slashes | .\" enable line breaks after slashes | ||||||
| .cflags 4 / | .cflags 4 / | ||||||
|  | 
 | ||||||
| .SH "NAME" | .SH "NAME" | ||||||
| nvf configuration specification | nvf \- Configuration specification for the nvf. | ||||||
| .SH "OPTIONS" | 
 | ||||||
| .PP | .SH "DESCRIPTION" | ||||||
| You can use the following options to configure nvf: | The nvf configuration specification provides a declarative structure for configuring Neovim using Nix with few | ||||||
| .PP | lines of Nix. This document outlines the available options and their usage to create modular, reusable, and | ||||||
|  | reproducible configurations using nvf's module system options. For tips, tricks and possible quirks with available | ||||||
|  | plugins please visit https://notashelf.github.io/nvf/ | ||||||
|  |  | ||||||
|  | @ -1,5 +1,5 @@ | ||||||
| .Dd January 1, 1980 | .Dd January 1, 1980 | ||||||
| .Dt nvf 1 | .Dt NVF 1 | ||||||
| .Os nvf | .Os nvf | ||||||
| .\" disable hyphenation | .\" disable hyphenation | ||||||
| .nh | .nh | ||||||
|  | @ -7,27 +7,46 @@ | ||||||
| .ad l | .ad l | ||||||
| .\" enable line breaks after slashes | .\" enable line breaks after slashes | ||||||
| .cflags 4 / | .cflags 4 / | ||||||
|  | 
 | ||||||
| .Sh NAME | .Sh NAME | ||||||
| .Nm nvf | .Nm nvf | ||||||
| .Nd A highly modular, extensible and distro-agnostic Neovim configuration framework for Nix/NixOS. | .Nd A modular, extensible, and distro-agnostic Neovim configuration framework for Nix/NixOS. | ||||||
| . | 
 | ||||||
|  | .Sh DESCRIPTION | ||||||
|  | .Nm nvf | ||||||
|  | is a highly modular, configurable, extensible, and easy-to-use Neovim configuration in Nix. | ||||||
|  | Designed for flexibility and ease of use, nvf allows you to easily configure your fully featured | ||||||
|  | Neovim instance with a few lines of Nix. | ||||||
|  | 
 | ||||||
|  | .Sh COMMANDS | ||||||
|  | The following commands are bundled with nvf to allow easier debugging of your configuration. | ||||||
|  | 
 | ||||||
|  | .Bl -tag -width Ds | ||||||
|  | .It Nm nvf-print-config | ||||||
|  | Outputs the full configuration of the current `nvf` setup. This command is useful for debugging | ||||||
|  | or inspecting the applied configuration. | ||||||
|  | .Pp | ||||||
|  | .It Nm nvf-print-config-path | ||||||
|  | Prints the file path to the configuration file currently in use. This command is helpful for locating | ||||||
|  | the source configuration file for troubleshooting or easily sharing it via online paste utilities. | ||||||
|  | .El | ||||||
|  | 
 | ||||||
| .Sh BUGS | .Sh BUGS | ||||||
| .Pp | .Pp | ||||||
| Please report any bugs that you might encounter on the | Please report any bugs on the project issue tracker: | ||||||
| \m[blue]\fBproject issue tracker\fR\m[]\&. | .Lk https://github.com/notashelf/nvf/issues | ||||||
| 
 | 
 | ||||||
| .Sh SEE ALSO | .Sh SEE ALSO | ||||||
| .Pp | .Pp | ||||||
| \fBnvf\fR(5) | .Fn nvf 5 | ||||||
| 
 | 
 | ||||||
| .Sh AUTHOR | .Sh AUTHOR | ||||||
| .Pp | .Pp | ||||||
| \fBnvf contributors\fR | .Fn nvf contributors | ||||||
| .RS 4 | .RS 4 | ||||||
| Author. | Primary contributors and maintainers of the project. | ||||||
| .RE | .RE | ||||||
| 
 | 
 | ||||||
| .Sh COPYRIGHT | .Sh COPYRIGHT | ||||||
| .br | .Pp | ||||||
| Copyright \(co 2023\(en2024 nvf contributors | Copyright (c) 2023–2025 nvf contributors. | ||||||
| .br |  | ||||||
|  |  | ||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue