nvf/docs/man/nvf.1

53 lines
1.3 KiB
Groff
Raw Normal View History

2023-12-09 19:21:36 +00:00
.Dd January 1, 1980
.Dt NVF 1
.Os nvf
2023-12-09 19:21:36 +00:00
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" enable line breaks after slashes
.cflags 4 /
2023-12-09 19:21:36 +00:00
.Sh NAME
.Nm nvf
.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
2023-12-09 19:21:36 +00:00
.Sh BUGS
.Pp
Please report any bugs on the project issue tracker:
.Lk https://github.com/notashelf/nvf/issues
2023-12-09 19:21:36 +00:00
.Sh SEE ALSO
.Pp
.Fn nvf 5
2023-12-09 19:21:36 +00:00
.Sh AUTHOR
.Pp
.Fn nvf contributors
2023-12-09 19:21:36 +00:00
.RS 4
Primary contributors and maintainers of the project.
2023-12-09 19:21:36 +00:00
.RE
.Sh COPYRIGHT
.Pp
Copyright (c) 20232025 nvf contributors.