From dd9102d8c0477afef5ad8e72662ce1d3f6191182 Mon Sep 17 00:00:00 2001
From: Navan Chauhan <navanchauhan@gmail.com>
Date: Sat, 9 Dec 2023 20:57:20 -0700
Subject: add initial docs

---
 docs/index/availability.index | Bin 0 -> 214 bytes
 docs/index/data.mdb           | Bin 0 -> 180224 bytes
 docs/index/index.json         |   1 +
 docs/index/navigator.index    | Bin 0 -> 17706 bytes
 4 files changed, 1 insertion(+)
 create mode 100644 docs/index/availability.index
 create mode 100755 docs/index/data.mdb
 create mode 100644 docs/index/index.json
 create mode 100644 docs/index/navigator.index

(limited to 'docs/index')

diff --git a/docs/index/availability.index b/docs/index/availability.index
new file mode 100644
index 0000000..05be8ee
Binary files /dev/null and b/docs/index/availability.index differ
diff --git a/docs/index/data.mdb b/docs/index/data.mdb
new file mode 100755
index 0000000..a419f4e
Binary files /dev/null and b/docs/index/data.mdb differ
diff --git a/docs/index/index.json b/docs/index/index.json
new file mode 100644
index 0000000..bc06509
--- /dev/null
+++ b/docs/index/index.json
@@ -0,0 +1 @@
+{"interfaceLanguages":{"swift":[{"children":[{"title":"Classes","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/init(logger:gopherdata_dir:gopherdata_host:gopherdata_port:enablesearch:disablegophermap:)","title":"init(logger: Logger, gopherdata_dir: String, gopherdata_host: String, gopherdata_port: Int, enableSearch: Bool, disableGophermap: Bool)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/disablegophermap","title":"let disableGophermap: Bool","type":"property"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/enablesearch","title":"let enableSearch: Bool","type":"property"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/gopherdata_dir","title":"let gopherdata_dir: String","type":"property"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/gopherdata_host","title":"let gopherdata_host: String","type":"property"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/gopherdata_port","title":"let gopherdata_port: Int","type":"property"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/logger","title":"let logger: Logger","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/channelread(context:data:)","title":"func channelRead(context: ChannelHandlerContext, data: NIOAny)","type":"method"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/channelreadcomplete(context:)","title":"func channelReadComplete(context: ChannelHandlerContext)","type":"method"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/errorcaught(context:error:)","title":"func errorCaught(context: ChannelHandlerContext, error: Error)","type":"method"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/generategopheritem(item_name:item_path:item_host:item_port:)","title":"func generateGopherItem(item_name: String, item_path: URL, item_host: String?, item_port: String?) -> String","type":"method"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/generategophermap(path:)","title":"func generateGopherMap(path: URL) -> [String]","type":"method"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/performsearch(query:)","title":"func performSearch(query: String) -> String","type":"method"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/preparegophermenu(path:)","title":"func prepareGopherMenu(path: URL) -> String","type":"method"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/preparepath(path:)","title":"func preparePath(path: String) -> URL","type":"method"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/requesthandler(path:)","title":"func requestHandler(path: URL) -> ResponseType","type":"method"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/sanitizeselectorpath(path:)","title":"func sanitizeSelectorPath(path: String) -> String","type":"method"},{"title":"Type Aliases","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/inboundin","title":"GopherHandler.InboundIn","type":"typealias"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/outboundout","title":"GopherHandler.OutboundOut","type":"typealias"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/handleradded(context:)","title":"func handlerAdded(context: ChannelHandlerContext)","type":"method"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/handlerremoved(context:)","title":"func handlerRemoved(context: ChannelHandlerContext)","type":"method"}],"path":"\/documentation\/swift_gopher\/gopherhandler\/channelhandler-implementations","title":"ChannelHandler Implementations","type":"symbol"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/unwrapinboundin(_:)","title":"func unwrapInboundIn(NIOAny) -> Self.InboundIn","type":"method"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/wrapinboundout(_:)","title":"func wrapInboundOut(Self.InboundOut) -> NIOAny","type":"method"}],"path":"\/documentation\/swift_gopher\/gopherhandler\/channelinboundhandler-implementations","title":"ChannelInboundHandler Implementations","type":"symbol"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/channelactive(context:)","title":"func channelActive(context: ChannelHandlerContext)","type":"method"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/channelinactive(context:)","title":"func channelInactive(context: ChannelHandlerContext)","type":"method"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/channelregistered(context:)","title":"func channelRegistered(context: ChannelHandlerContext)","type":"method"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/channelunregistered(context:)","title":"func channelUnregistered(context: ChannelHandlerContext)","type":"method"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/channelwritabilitychanged(context:)","title":"func channelWritabilityChanged(context: ChannelHandlerContext)","type":"method"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/userinboundeventtriggered(context:event:)","title":"func userInboundEventTriggered(context: ChannelHandlerContext, event: Any)","type":"method"}],"path":"\/documentation\/swift_gopher\/gopherhandler\/_channelinboundhandler-implementations","title":"_ChannelInboundHandler Implementations","type":"symbol"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/gopherhandler\/wrapoutboundout(_:)","title":"func wrapOutboundOut(Self.OutboundOut) -> NIOAny","type":"method"}],"path":"\/documentation\/swift_gopher\/gopherhandler\/_emittingchannelhandler-implementations","title":"_EmittingChannelHandler Implementations","type":"symbol"}],"path":"\/documentation\/swift_gopher\/gopherhandler","title":"GopherHandler","type":"class"},{"title":"Structures","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/init()","title":"init()","type":"init"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/init(from:)","title":"init(from: Decoder) throws","type":"init"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/init(gopherhostname:host:port:gopherdatadir:disablesearch:disablegophermap:)","title":"init(gopherHostName: String, host: String, port: Int, gopherDataDir: String, disableSearch: Bool, disableGophermap: Bool)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/disablegophermap","title":"var disableGophermap: Bool","type":"property"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/disablesearch","title":"var disableSearch: Bool","type":"property"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/gopherdatadir","title":"var gopherDataDir: String","type":"property"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/gopherhostname","title":"var gopherHostName: String","type":"property"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/host","title":"var host: String","type":"property"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/port","title":"var port: Int","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/run()-2mp76","title":"func run() throws","type":"method"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/validate()","title":"func validate() throws","type":"method"},{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/_errorlabel","title":"static var _errorLabel: String","type":"property"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/ascommand","title":"static var asCommand: ParsableCommand.Type","type":"property"},{"title":"Type Methods","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/_dumphelp()","title":"static func _dumpHelp() -> String","type":"method"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/completionscript(for:)","title":"static func completionScript(for: CompletionShell) -> String","type":"method"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/exit(witherror:)","title":"static func exit(withError: Error?) -> Never","type":"method"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/exitcode(for:)","title":"static func exitCode(for: Error) -> ExitCode","type":"method"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/fullmessage(for:)","title":"static func fullMessage(for: Error) -> String","type":"method"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/helpmessage(columns:)","title":"static func helpMessage(columns: Int?) -> String","type":"method"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/helpmessage(includehidden:columns:)","title":"static func helpMessage(includeHidden: Bool, columns: Int?) -> String","type":"method"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/message(for:)","title":"static func message(for: Error) -> String","type":"method"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/parse(_:)","title":"static func parse([String]?) throws -> Self","type":"method"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/parseorexit(_:)","title":"static func parseOrExit([String]?) -> Self","type":"method"}],"path":"\/documentation\/swift_gopher\/swiftgopher\/parsablearguments-implementations","title":"ParsableArguments Implementations","type":"symbol"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/run()-250ya","title":"func run() throws","type":"method"},{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/_commandname","title":"static var _commandName: String","type":"property"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/configuration","title":"static var configuration: CommandConfiguration","type":"property"},{"title":"Type Methods","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/helpmessage(for:columns:)","title":"static func helpMessage(for: ParsableCommand.Type, columns: Int?) -> String","type":"method"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/helpmessage(for:includehidden:columns:)","title":"static func helpMessage(for: ParsableCommand.Type, includeHidden: Bool, columns: Int?) -> String","type":"method"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/main()","title":"static func main()","type":"method"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/main(_:)","title":"static func main([String]?)","type":"method"},{"path":"\/documentation\/swift_gopher\/swiftgopher\/parseasroot(_:)","title":"static func parseAsRoot([String]?) throws -> ParsableCommand","type":"method"}],"path":"\/documentation\/swift_gopher\/swiftgopher\/parsablecommand-implementations","title":"ParsableCommand Implementations","type":"symbol"}],"path":"\/documentation\/swift_gopher\/swiftgopher","title":"swiftGopher","type":"struct"},{"title":"Variables","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/versionstring","title":"let versionString: String","type":"var"},{"title":"Functions","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/buildversionstringresponse()","title":"func buildVersionStringResponse() -> String","type":"func"},{"path":"\/documentation\/swift_gopher\/filetypetogopheritem(filetype:)","title":"func fileTypeToGopherItem(fileType: gopherFileType) -> String","type":"func"},{"path":"\/documentation\/swift_gopher\/getfiletype(fileextension:)","title":"func getFileType(fileExtension: String) -> gopherFileType","type":"func"},{"title":"Enumerations","type":"groupMarker"},{"children":[{"title":"Enumeration Cases","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/responsetype\/data(_:)","title":"case data(Data)","type":"case"},{"path":"\/documentation\/swift_gopher\/responsetype\/string(_:)","title":"case string(String)","type":"case"}],"path":"\/documentation\/swift_gopher\/responsetype","title":"ResponseType","type":"enum"},{"children":[{"title":"Enumeration Cases","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/binary","title":"case binary","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/bindos","title":"case bindos","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/binhex","title":"case binhex","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/bitmap","title":"case bitmap","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/directory","title":"case directory","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/doc","title":"case doc","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/error","title":"case error","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/gif","title":"case gif","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/html","title":"case html","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/image","title":"case image","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/indexsearch","title":"case indexSearch","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/message","title":"case message","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/movie","title":"case movie","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/nameserver","title":"case nameserver","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/pdf","title":"case pdf","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/png","title":"case png","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/redundantserver","title":"case redundantServer","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/rtf","title":"case rtf","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/sound","title":"case sound","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/telnet","title":"case telnet","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/text","title":"case text","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/tn3270session","title":"case tn3270Session","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/uuencoded","title":"case uuencoded","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/wavfile","title":"case wavfile","type":"case"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/xml","title":"case xml","type":"case"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/swift_gopher\/gopherfiletype\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/swift_gopher\/gopherfiletype\/equatable-implementations","title":"Equatable Implementations","type":"symbol"}],"path":"\/documentation\/swift_gopher\/gopherfiletype","title":"gopherFileType","type":"enum"}],"path":"\/documentation\/swift_gopher","title":"swift-gopher","type":"module"}]},"schemaVersion":{"major":0,"minor":1,"patch":1}}
\ No newline at end of file
diff --git a/docs/index/navigator.index b/docs/index/navigator.index
new file mode 100644
index 0000000..69eb6bf
Binary files /dev/null and b/docs/index/navigator.index differ
-- 
cgit v1.2.3