<commit_before>/*
 * tspfs: a usermode filesystem that uses fuse
 * (see http://fuse.sourceforge.net) to export TSP
 * symbols as files in a directory.
 *
 * (c) <NAME>, <NAME> 2006
 *
 * This program is distributed under the terms of the GNU LGPL.
 * See COPYING.
 */

/** 
 * @defgroup TSPFS tspfs
 * @ingroup TSP_Consumers
 *
 * tspfs: is a usermode filesystem that uses fuse
 * (see http://fuse.sourceforge.net) to export TSP
 * symbols as files in a directory.
 *
 * \par usage: tspfs [--url=<tsp_provider_url>] [--sync=<sampling period>]|[--async] [--filter] <mount_point>
                --url                   the url to connect to, default: rpc://localhost
                --sync=<period>         use synchronous mode to read the sample values with a period <period>
                --async                 use asynchronous mode to read the sample values, this is the default
                --filter                basic filter used to match the symbol names
                --ext=<ext>             Suffix file names with <ext>, handy for windows browsing

 *
 * \section Sample tspfs session
 * \verbatim
 
 # Start a sample bb
 $ bb_simu -s > /dev/null 2>&1 &
 
 # TSPize the bb's data
 $ bb_tsp_provide bb_simu 10 &
 
 # Create the mount point, mount the tspfs filesystem
 $ mkdir mp/
 $ tspfs --ext=.txt --url=rpc://localhost/bb_simu --sync=1 mp/
 
 # List the symbols
 $ ls -l mp/
 total 0
 -rw-rw-rw-  1 root root 512 jan  1  1970 bb_simu_1_HugeArray[0].txt<commit_msg>Small doxygen fix < and > must be escaped better use ul and li for itemized list<commit_after>/*
 * tspfs: a usermode filesystem that uses fuse
 * (see http://fuse.sourceforge.net) to export TSP
 * symbols as files in a directory.
 *
 * (c) <NAME>, <NAME> 2006
 *
 * This program is distributed under the terms of the GNU LGPL.
 * See COPYING.
 */

/** 
 * @defgroup TSPFS tspfs
 * @ingroup TSP_Consumers
 *
 * tspfs: is a usermode filesystem that uses fuse
 * (see http://fuse.sourceforge.net) to export TSP
 * symbols as files in a directory.
 *
 * \par usage: tspfs [--url=\<tsp_provider_url\>] [--sync=\<sampling period\>]|[--async] [--filter] \<mount_point\>
 * \par 
 * <ul>
 *   <li> \b --url                   the url to connect to, default: rpc://localhost </li>
 *   <li> \b --sync=\<period\>         use synchronous mode to read the sample values with a period \<period\> </li>
 *   <li> \b --async                 use asynchronous mode to read the sample values, this is the default </li>
 *   <li> \b --filter                basic filter used to match the symbol names </li>
 *   <li> \b --ext=\<ext\>             Suffix file names with \<ext\>, handy for windows browsing </li>
 *
 * \section Sample tspfs session
 * \verbatim
 
 # Start a sample bb
 $ bb_simu -s > /dev/null 2>&1 &
 
 # TSPize the bb's data
 $ bb_tsp_provide bb_simu 10 &
 
 # Create the mount point, mount the tspfs filesystem
 $ mkdir mp/
 $ tspfs --ext=.txt --url=rpc://localhost/bb_simu --sync=1 mp/
 
 # List the symbols
 $ ls -l mp/
 total 0
 -rw-rw-rw-  1 root root 512 jan  1  1970 bb_simu_1_HugeArray[0].txt
{'fraction_non_alphanumeric': 0.12062256809338522, 'fraction_numerical': 0.013618677042801557, 'mean_word_length': 2.3496199782844736, 'pattern_counts': {'":': 0, '<': 33, '<?xml version=': 0, '>': 37, 'https://': 0, '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': '2856282', 'n_tokens_mistral': 1082, 'n_tokens_neox': 957, 'n_words': 376}