🌅

Author: hugopl

.gitignore

@@ -0,0 +1 @@
+build/

LICENSE

@@ -0,0 +1,13 @@
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                   Version 2, December 2004
+
+Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+Everyone is permitted to copy and distribute verbatim or modified
+copies of this license document, and changing it is allowed as long
+as the name is changed.
+
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. You just DO WHAT THE FUCK YOU WANT TO.

Makefile

@@ -0,0 +1,12 @@
+.PHONY: install all clean
+PREFIX ?= /usr
+
+all:
+	./build-manpages
+
+install:
+	find build/ -name "*.7" -type f -print0 | xargs -0 gzip --keep -f
+	install -D -m0644 ./build/*.7.gz $(DESTDIR)$(PREFIX)/share/man/man7/
+
+clean:
+	rm -rf build/*

README.md

@@ -0,0 +1,43 @@
+# HTTP Status Code Manual
+
+This is exactly like [statcode](https://github.com/shobrook/statcode), but real manpages instead of a python package.
+
+# Usage
+
+```
+$ man 404
+```
+
+The man pages are installed in category 7 — _Miscellaneous (including macro packages and conventions)_ — so you can also do:
+
+```
+$ man 7 500
+```
+
+# Installing
+
+You need ruby to generate the man pages, after this you just need the manpage reader.
+
+```
+$ make install
+```
+
+# Installing on ArchLinux
+
+```
+yay -S http-status-code-manpages
+```
+
+## Contributing
+
+1. Fork it (<https://github.com/hugopl/http-status-code-manpages/fork>)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+Any ideas/suggestions, fill in an issue.
+
+## Contributors
+
+- [Hugo Parente Lima](https://github.com/hugopl) - creator and maintainer

build-manpages

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "yaml"
+require "fileutils"
+require "ap"
+
+TEMPLATE = <<-EOF
+.\\" Copyright  © CC BY-SA Mozilla Contributors <https://developer.mozilla.org/en-US/docs/Web/HTTP/Status>
+.\\"
+.\\" Text is available under the Creative Commons Attribution-ShareAlike License; additional terms may apply.
+.\\" Wikipedia® is a registered trademark of the Wikimedia Foundation, Inc., a non-profit organization.
+.\\"
+.TH %{code} 7  "" "" "HTTP Status Code Manual"
+.SH CODE
+%{code} \- %{message}
+.SH CATEGORY
+%{category}
+.SH DESCRIPTION
+%{description}
+EOF
+
+BUILD_DIR = "./build"
+FileUtils.mkdir_p(BUILD_DIR)
+
+codes = YAML.safe_load(File.read("./data/code_descriptions.yml"))
+codes.each do |code, info|
+  info = info.transform_keys!(&:to_sym)
+  info[:code] = code
+  File.open("#{BUILD_DIR}/#{code}.7", "w") do |f|
+    f.printf(TEMPLATE, info)
+  end
+end
+puts "#{codes.size} man pages created at #{BUILD_DIR}."