<commit_before>hs._asm.bonjour
===============

Find and publish network services advertised by multicast DNS (Bonjour) with Hammerspoon.

This module will allow you to discover services advertised on your network through multicast DNS and publish services offered by your computer.

### Installation

If you wish to build this module yourself, and have XCode installed on your Mac, the best way (you are welcome to clone the entire repository if you like, but no promises on the current state of anything else) is to do the following:

~~~sh
$ svn export https://github.com/asmagill/hammerspoon_asm/trunk/bonjour
$ cd bonjour
$ [HS_APPLICATION=/Applications] [PREFIX=~/.hammerspoon] make install
~~~

If your Hammerspoon application is located in `/Applications`, you can leave out the `HS_APPLICATION` environment variable, and if your Hammerspoon files are located in their default location, you can leave out the `PREFIX` environment variable.  For most people it will be sufficient to just type `make docs install`.

As always, if you are updating from an earlier version it is recommended to fully quit and restart Hammerspoon after installing this module to ensure that the latest version of the module is loaded into memory.

### Usage
~~~lua
bonjour = require("hs._asm.bonjour")
~~~

### Submodule(s)

* [hs._asm.bonjour.service](Service.md)

### Contents

##### Module Constructors
* <a href="#new">bonjour.new() -> browserObject</a>

##### Module Functions
* <a href="#machineServices">bonjour.machineServices(target, callback) -> none</a>
* <a href="#networkServices">bonjour.networkServices(callback, [timeout]) -> none</a>

##### Module Methods
* <a href="#findBrowsableDomains">bonjour:findBrowsableDomains(callback) -> browserObject</a>
* <a href="#findRegistrationDomains">bonjour:findRegistrationDomains(callback) -> browserObject</a>
* <a href="#findServices">bonjour:findServices(type, [domain], [callback]) -> browserObject</a>

* <a href="#includesPeerToPeer">bonjour:includesPeerToPeer([value]) -> current value | browserObject</a>
* <a href="#stop">bonjour:stop() -> browserObject</a>

##### Module Constants
* <a href="#serviceTypes">bonjour.serviceTypes</a>

- - -

### Module Constructors

<a name="new"></a><commit_msg>correct link to submodule docs<commit_after>hs._asm.bonjour
===============

Find and publish network services advertised by multicast DNS (Bonjour) with Hammerspoon.

This module will allow you to discover services advertised on your network through multicast DNS and publish services offered by your computer.

### Installation

If you wish to build this module yourself, and have XCode installed on your Mac, the best way (you are welcome to clone the entire repository if you like, but no promises on the current state of anything else) is to do the following:

~~~sh
$ svn export https://github.com/asmagill/hammerspoon_asm/trunk/bonjour
$ cd bonjour
$ [HS_APPLICATION=/Applications] [PREFIX=~/.hammerspoon] make install
~~~

If your Hammerspoon application is located in `/Applications`, you can leave out the `HS_APPLICATION` environment variable, and if your Hammerspoon files are located in their default location, you can leave out the `PREFIX` environment variable.  For most people it will be sufficient to just type `make docs install`.

As always, if you are updating from an earlier version it is recommended to fully quit and restart Hammerspoon after installing this module to ensure that the latest version of the module is loaded into memory.

### Usage
~~~lua
bonjour = require("hs._asm.bonjour")
~~~

### Submodule(s)

* [hs._asm.bonjour.service](SERVICE.md)

### Contents

##### Module Constructors
* <a href="#new">bonjour.new() -> browserObject</a>

##### Module Functions
* <a href="#machineServices">bonjour.machineServices(target, callback) -> none</a>
* <a href="#networkServices">bonjour.networkServices(callback, [timeout]) -> none</a>

##### Module Methods
* <a href="#findBrowsableDomains">bonjour:findBrowsableDomains(callback) -> browserObject</a>
* <a href="#findRegistrationDomains">bonjour:findRegistrationDomains(callback) -> browserObject</a>
* <a href="#findServices">bonjour:findServices(type, [domain], [callback]) -> browserObject</a>

* <a href="#includesPeerToPeer">bonjour:includesPeerToPeer([value]) -> current value | browserObject</a>
* <a href="#stop">bonjour:stop() -> browserObject</a>

##### Module Constants
* <a href="#serviceTypes">bonjour.serviceTypes</a>

- - -

### Module Constructors

<a name="new"></a>
{'fraction_non_alphanumeric': 0.12724451341166038, 'fraction_numerical': 0.0, 'mean_word_length': 5.764617691154423, 'pattern_counts': {'":': 0, '<': 43, '<?xml version=': 0, '>': 59, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3258309', 'n_tokens_mistral': 1272, 'n_tokens_neox': 1219, 'n_words': 453}