{"id":15497166,"url":"https://github.com/jwerle/rfc","last_synced_at":"2025-04-22T22:15:10.712Z","repository":{"id":12862044,"uuid":"15538205","full_name":"jwerle/rfc","owner":"jwerle","description":"IETF RFC reader tool","archived":false,"fork":false,"pushed_at":"2022-01-17T16:09:05.000Z","size":29,"stargazers_count":17,"open_issues_count":2,"forks_count":3,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-01-07T15:14:06.019Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jwerle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-12-30T22:44:42.000Z","updated_at":"2022-10-26T18:37:19.000Z","dependencies_parsed_at":"2022-07-12T15:04:50.172Z","dependency_job_id":null,"html_url":"https://github.com/jwerle/rfc","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwerle%2Frfc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwerle%2Frfc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwerle%2Frfc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwerle%2Frfc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jwerle","download_url":"https://codeload.github.com/jwerle/rfc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234296418,"owners_count":18809999,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-02T08:31:16.911Z","updated_at":"2025-01-17T01:02:43.944Z","avatar_url":"https://github.com/jwerle.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"rfc(1)\n=====\n\n[IETF](http://www.ietf.org) [RFC](http://www.ietf.org/rfc) reader tool\n\n## install\n\nwith **npm**\n\n```sh\n$ npm install rfc -g\n```\n\nwith **git**\n\n```sh\n$ npm install github:jwerle/rfc -g\n```\n\n## usage\n\n**search** \n\n```\n$ rfc search punycode\n  ... searching\n\n  3492   Punycode: A Bootstring encoding of Unicode for Internationalized\n         Domain Names in Applications (IDNA). A. Costello. March 2003.\n         (Format: TXT=67439 bytes) (Updated by RFC5891) (Status: PROPOSED\n         STANDARD)\n\n  1 result\n```\n\n**view**\n\n```\n$ rfc open 3492\n\nNetwork Working Group                                        A. Costello\nRequest for Comments: 3492                 Univ. of California, Berkeley\nCategory: Standards Track                                     March 2003\n\n\n              Punycode: A Bootstring encoding of Unicode\n       for Internationalized Domain Names in Applications (IDNA)\n\nStatus of this Memo\n\n   This document specifies an Internet standards track protocol for the\n   Internet community, and requests discussion and suggestions for\n   improvements.  Please refer to the current edition of the \"Internet\n   Official Protocol Standards\" (STD 1) for the standardization state\n   and status of this protocol.  Distribution of this memo is unlimited.\n\nCopyright Notice\n\n   Copyright (C) The Internet Society (2003).  All Rights Reserved.\n\nAbstract\n\n   Punycode is a simple and efficient transfer encoding syntax designed\n   for use with Internationalized Domain Names in Applications (IDNA).\n   It uni\n\n...\n```\n\n### module\n\n```js\nvar rfc = require('rfc')\n\nvar count = 0;\nrfc.search('idna')\n.on('error', function (err) {\n  // handle error\n})\n.on('result', function (result) {\n  count++;\n  console.log(\"  %d %s\", result.rfc, result.desc);\n})\n.on('end', function () {\n  console.log(\"  got %d result(s)\", count);\n});\n```\n\n## api\n\n### RFC\\_BASE\\_URL\n\nIETF RFC Base URL\n\n### RFC\\_INDEX\\_URL\n\nIETF RFC Index file URL\n\n### RFC\\_CACHE\n\nDefault RFC cache\n\n### RFC\\_CACHE\\_INDEX\n\nDefault RFC Index cache file name\n\n### sync()\n\nSync RFC Index file to a local file (`RFC_CACHE_INDEX`) in a directory\ndefined by the environment variable `RFC_CACHE`.\n\n`sync()` returns a stream that is readable.\n\n```js\nrfc.sync()\n.on('data', function (chunk) {\n  console.log(chunk)\n});\n```\n\n### search(query)\n\nSearches RFC Index based on a query\n\n```js\nrfc.search('idna')\n.on('result', function (result) {\n  console.log(\"%d (%s) %s\",\n    result.rfc,\n    result.path,\n    result.desc);\n});\n```\n\n## debug\n\n`DEBUG` tags: `rfc:search`, `rfc:match`, `rfc:sync`\nSee [visionmedia/debug](https://github.com/visionmedia/debug) for details on usage.\n\n## license\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwerle%2Frfc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjwerle%2Frfc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwerle%2Frfc/lists"}